Function removeByValueRange

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

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

    Parameters

    • bin: string

      The name of the bin, which must contain a Map 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: maps.returnType

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

    Returns MapOperation

    Operation that can be passed to the Client#operate command.

    Remarks

    This operation returns the removed data specified by returnType.

    See

    Instead of passing returnType, you can also use ~MapOperation#andReturn|MapOperation#andReturn to select what data to return.

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR