Skip to main content

ARSCAN

Read occupied array slots with their indexes.
1 min read

Arguments#

keystringrequired#

The array key.

startnumber | stringrequired#

The first index of the inclusive range.

endnumber | stringrequired#

The last index of the inclusive range.

optionsObject#
limitnumber#

Maximum number of occupied slots to return. If provided, it must be greater than zero.

Response#

[string, TData][]required

Index-value pairs for occupied slots. Empty slots are skipped; a missing key returns an empty list. TypeScript returns indexes as strings; Python returns integers.

Values use the SDK's automatic deserialization. Use TData to describe stored JSON values; it defaults to string.

See the server command reference for protocol details.

Was this page helpful?