Function removeByValueRange

  • removeByValueRange(bin, begin, end, returnType?): InvertibleListOp

  • Removes one or more items identified by a range of values from the list.

    Parameters

    • bin: string

      The name of the bin. The bin must contain a List value.

    • begin: null | number

      Start values in the range (inclusive). If set to null, the range includes all values less than the end value.

    • end: null | number

      End value in the range (exclusive). If set to null, the range includes all values greater than or equal to the begin value.

    • OptionalreturnType: lists.returnType

      The return type indicating what data of the removed item(s) to return (if any).

    Returns InvertibleListOp

    List operation that can be used with the Client#operate command.

    Remarks

    This operation returns the data specified by returnType.

    See

    • Use {lists~ListOperation#invertSelection|ListOperation#invertSelection} to invert the selection of items affected by this operation.
    • Instead of passing returnType, you can also use ~ListOperation#andReturn|ListOperation#andReturn to select what data to return.

    Since

    v3.4.0

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR