SCAN - Upstash Documentation

Arguments#

cursorstring#

The cursor value. Start with "0" on the first call, then use the cursor returned by each call for the next. It's a string to safely support large numbers that might exceed JavaScript's number limits.

optionsObject#

matchstring#

Glob-style pattern to filter by field names.

countnumber#

Number of fields to return per call.

typestring#

Filter by type. For example string, hash, set, zset, list, stream.

Response#

[string, string[]]required

Returns the next cursor and the list of matching keys. When the returned cursor is "0", the scan is complete.