Function removeByIndex

  • removeByIndex(bin, index, returnType?): MapOperation

  • Removes a single item identified by its index value from the map.

    Parameters

    • bin: string

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

    • index: number

      Index of the entry to remove.

    • 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