Function removeByRankRange

  • removeByRankRange(bin, rank, count?, returnType?): MapOperation

  • Removes one or more items in the specified rank range from the map.

    Parameters

    • bin: string

      The name of the bin, which must contain a Map value.

    • rank: number

      Starting rank.

    • Optionalcount: null | number

      Number of items to delete. If undefined, the range includes all items starting from rank.

    • 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