Function pull

  • pull<CItem>(collectionId, itemId, propertyName, value, options?): Promise<CItem | null>

  • Type Parameters

    Parameters

    • collectionId: string

      The ID of the collection to pull/remove the items from.

    • itemId: ItemID

      ItemID to filter the _id field when performing the operation.

    • propertyName: Extract<keyof CItem, string>

      Property name for the array field.

    • value: any

      Values to pull from array.

    • Optionaloptions: WeivDataOptions

      An object containing options to use when processing this operation.

    Returns Promise<CItem | null>

    Fulfilled - Updated item. Rejected - The error caused the rejection.

    Description

    You can use pull function to pull values from an array field in an item. This function uses $pull operator to remove data from an array.

Settings

Member Visibility