@upstash/redis 1.40.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -0
- package/{chunk-RLVWMRRX.mjs → chunk-CGMWROAN.mjs} +557 -4
- package/cloudflare.d.mts +2 -2
- package/cloudflare.d.ts +2 -2
- package/cloudflare.js +557 -4
- package/cloudflare.mjs +1 -1
- package/docs/advanced.mdx +83 -0
- package/docs/commands/array/arcount.mdx +28 -0
- package/docs/commands/array/ardel.mdx +30 -0
- package/docs/commands/array/ardelrange.mdx +32 -0
- package/docs/commands/array/arget.mdx +33 -0
- package/docs/commands/array/argetrange.mdx +38 -0
- package/docs/commands/array/argrep.mdx +69 -0
- package/docs/commands/array/arinfo.mdx +49 -0
- package/docs/commands/array/arinsert.mdx +32 -0
- package/docs/commands/array/arlastitems.mdx +40 -0
- package/docs/commands/array/arlen.mdx +28 -0
- package/docs/commands/array/armget.mdx +31 -0
- package/docs/commands/array/armset.mdx +31 -0
- package/docs/commands/array/arnext.mdx +25 -0
- package/docs/commands/array/arop.mdx +44 -0
- package/docs/commands/array/arring.mdx +36 -0
- package/docs/commands/array/arscan.mdx +42 -0
- package/docs/commands/array/arseek.mdx +34 -0
- package/docs/commands/array/arset.mdx +35 -0
- package/docs/commands/auth/echo.mdx +24 -0
- package/docs/commands/auth/ping.mdx +21 -0
- package/docs/commands/bitmap/bitcount.mdx +39 -0
- package/docs/commands/bitmap/bitop.mdx +142 -0
- package/docs/commands/bitmap/bitpos.mdx +39 -0
- package/docs/commands/bitmap/getbit.mdx +28 -0
- package/docs/commands/bitmap/setbit.mdx +31 -0
- package/docs/commands/connection/client_setinfo.mdx +91 -0
- package/docs/commands/functions/call.mdx +72 -0
- package/docs/commands/functions/call_ro.mdx +57 -0
- package/docs/commands/functions/delete.mdx +22 -0
- package/docs/commands/functions/flush.mdx +16 -0
- package/docs/commands/functions/list.mdx +72 -0
- package/docs/commands/functions/load.mdx +64 -0
- package/docs/commands/functions/stats.mdx +46 -0
- package/docs/commands/generic/del.mdx +29 -0
- package/docs/commands/generic/exists.mdx +26 -0
- package/docs/commands/generic/expire.mdx +29 -0
- package/docs/commands/generic/expireat.mdx +29 -0
- package/docs/commands/generic/keys.mdx +32 -0
- package/docs/commands/generic/persist.mdx +23 -0
- package/docs/commands/generic/pexpire.mdx +28 -0
- package/docs/commands/generic/pexpireat.mdx +29 -0
- package/docs/commands/generic/pttl.mdx +23 -0
- package/docs/commands/generic/randomkey.mdx +21 -0
- package/docs/commands/generic/rename.mdx +28 -0
- package/docs/commands/generic/renamenx.mdx +28 -0
- package/docs/commands/generic/scan.mdx +38 -0
- package/docs/commands/generic/touch.mdx +23 -0
- package/docs/commands/generic/ttl.mdx +23 -0
- package/docs/commands/generic/type.mdx +27 -0
- package/docs/commands/generic/unlink.mdx +29 -0
- package/docs/commands/hash/hdel.mdx +28 -0
- package/docs/commands/hash/hexists.mdx +30 -0
- package/docs/commands/hash/hexpire.mdx +49 -0
- package/docs/commands/hash/hexpireat.mdx +48 -0
- package/docs/commands/hash/hexpiretime.mdx +35 -0
- package/docs/commands/hash/hget.mdx +29 -0
- package/docs/commands/hash/hgetall.mdx +27 -0
- package/docs/commands/hash/hgetdel.mdx +67 -0
- package/docs/commands/hash/hgetex.mdx +123 -0
- package/docs/commands/hash/hincrby.mdx +34 -0
- package/docs/commands/hash/hincrbyfloat.mdx +34 -0
- package/docs/commands/hash/hkeys.mdx +28 -0
- package/docs/commands/hash/hlen.mdx +28 -0
- package/docs/commands/hash/hmget.mdx +33 -0
- package/docs/commands/hash/hpersist.mdx +37 -0
- package/docs/commands/hash/hpexpire.mdx +50 -0
- package/docs/commands/hash/hpexpireat.mdx +48 -0
- package/docs/commands/hash/hpexpiretime.mdx +35 -0
- package/docs/commands/hash/hpttl.mdx +35 -0
- package/docs/commands/hash/hrandfield.mdx +57 -0
- package/docs/commands/hash/hscan.mdx +65 -0
- package/docs/commands/hash/hset.mdx +32 -0
- package/docs/commands/hash/hsetex.mdx +186 -0
- package/docs/commands/hash/hsetnx.mdx +30 -0
- package/docs/commands/hash/hstrlen.mdx +28 -0
- package/docs/commands/hash/httl.mdx +35 -0
- package/docs/commands/hash/hvals.mdx +29 -0
- package/docs/commands/json/arrappend.mdx +35 -0
- package/docs/commands/json/arrindex.mdx +37 -0
- package/docs/commands/json/arrinsert.mdx +34 -0
- package/docs/commands/json/arrlen.mdx +26 -0
- package/docs/commands/json/arrpop.mdx +36 -0
- package/docs/commands/json/arrtrim.mdx +34 -0
- package/docs/commands/json/clear.mdx +30 -0
- package/docs/commands/json/del.mdx +26 -0
- package/docs/commands/json/forget.mdx +26 -0
- package/docs/commands/json/get.mdx +53 -0
- package/docs/commands/json/merge.mdx +32 -0
- package/docs/commands/json/mget.mdx +27 -0
- package/docs/commands/json/mset.mdx +26 -0
- package/docs/commands/json/numincrby.mdx +33 -0
- package/docs/commands/json/nummultby.mdx +33 -0
- package/docs/commands/json/objkeys.mdx +27 -0
- package/docs/commands/json/objlen.mdx +27 -0
- package/docs/commands/json/set.mdx +42 -0
- package/docs/commands/json/strappend.mdx +32 -0
- package/docs/commands/json/strlen.mdx +26 -0
- package/docs/commands/json/toggle.mdx +28 -0
- package/docs/commands/json/type.mdx +28 -0
- package/docs/commands/list/lindex.mdx +32 -0
- package/docs/commands/list/linsert.mdx +41 -0
- package/docs/commands/list/llen.mdx +26 -0
- package/docs/commands/list/lmove.mdx +34 -0
- package/docs/commands/list/lpop.mdx +37 -0
- package/docs/commands/list/lpos.mdx +56 -0
- package/docs/commands/list/lpush.mdx +32 -0
- package/docs/commands/list/lpushx.mdx +38 -0
- package/docs/commands/list/lrange.mdx +37 -0
- package/docs/commands/list/lrem.mdx +33 -0
- package/docs/commands/list/lset.mdx +34 -0
- package/docs/commands/list/ltrim.mdx +33 -0
- package/docs/commands/list/rpop.mdx +37 -0
- package/docs/commands/list/rpush.mdx +32 -0
- package/docs/commands/list/rpushx.mdx +38 -0
- package/docs/commands/overview.mdx +692 -0
- package/docs/commands/pubsub/psubscribe.mdx +36 -0
- package/docs/commands/pubsub/publish.mdx +27 -0
- package/docs/commands/pubsub/subscribe.mdx +28 -0
- package/docs/commands/scripts/eval.mdx +36 -0
- package/docs/commands/scripts/eval_ro.mdx +36 -0
- package/docs/commands/scripts/evalsha.mdx +36 -0
- package/docs/commands/scripts/evalsha_ro.mdx +36 -0
- package/docs/commands/scripts/script_exists.mdx +26 -0
- package/docs/commands/scripts/script_flush.mdx +28 -0
- package/docs/commands/scripts/script_load.mdx +28 -0
- package/docs/commands/server/dbsize.mdx +22 -0
- package/docs/commands/server/flushall.mdx +25 -0
- package/docs/commands/server/flushdb.mdx +25 -0
- package/docs/commands/set/sadd.mdx +32 -0
- package/docs/commands/set/scard.mdx +26 -0
- package/docs/commands/set/sdiff.mdx +27 -0
- package/docs/commands/set/sdiffstore.mdx +32 -0
- package/docs/commands/set/sinter.mdx +27 -0
- package/docs/commands/set/sinterstore.mdx +33 -0
- package/docs/commands/set/sismember.mdx +30 -0
- package/docs/commands/set/smembers.mdx +25 -0
- package/docs/commands/set/smismember.mdx +31 -0
- package/docs/commands/set/smove.mdx +34 -0
- package/docs/commands/set/spop.mdx +36 -0
- package/docs/commands/set/srandmember.mdx +36 -0
- package/docs/commands/set/srem.mdx +29 -0
- package/docs/commands/set/sscan.mdx +39 -0
- package/docs/commands/set/sunion.mdx +27 -0
- package/docs/commands/set/sunionstore.mdx +33 -0
- package/docs/commands/stream/xack.mdx +37 -0
- package/docs/commands/stream/xackdel.mdx +211 -0
- package/docs/commands/stream/xadd.mdx +137 -0
- package/docs/commands/stream/xautoclaim.mdx +80 -0
- package/docs/commands/stream/xclaim.mdx +84 -0
- package/docs/commands/stream/xdel.mdx +34 -0
- package/docs/commands/stream/xdelex.mdx +119 -0
- package/docs/commands/stream/xgroup.mdx +141 -0
- package/docs/commands/stream/xinfo.mdx +77 -0
- package/docs/commands/stream/xlen.mdx +22 -0
- package/docs/commands/stream/xpending.mdx +75 -0
- package/docs/commands/stream/xrange.mdx +59 -0
- package/docs/commands/stream/xread.mdx +65 -0
- package/docs/commands/stream/xreadgroup.mdx +87 -0
- package/docs/commands/stream/xrevrange.mdx +65 -0
- package/docs/commands/stream/xtrim.mdx +75 -0
- package/docs/commands/string/append.mdx +28 -0
- package/docs/commands/string/decr.mdx +27 -0
- package/docs/commands/string/decrby.mdx +30 -0
- package/docs/commands/string/get.mdx +34 -0
- package/docs/commands/string/getdel.mdx +29 -0
- package/docs/commands/string/getrange.mdx +34 -0
- package/docs/commands/string/getset.mdx +28 -0
- package/docs/commands/string/incr.mdx +27 -0
- package/docs/commands/string/incrby.mdx +30 -0
- package/docs/commands/string/incrbyfloat.mdx +30 -0
- package/docs/commands/string/mget.mdx +31 -0
- package/docs/commands/string/mset.mdx +32 -0
- package/docs/commands/string/msetnx.mdx +29 -0
- package/docs/commands/string/set.mdx +79 -0
- package/docs/commands/string/setrange.mdx +38 -0
- package/docs/commands/string/strlen.mdx +26 -0
- package/docs/commands/transaction.mdx +22 -0
- package/docs/commands/zset/zadd.mdx +102 -0
- package/docs/commands/zset/zcard.mdx +31 -0
- package/docs/commands/zset/zcount.mdx +47 -0
- package/docs/commands/zset/zdiffstore.mdx +33 -0
- package/docs/commands/zset/zincrby.mdx +37 -0
- package/docs/commands/zset/zinterstore.mdx +98 -0
- package/docs/commands/zset/zlexcount.mdx +43 -0
- package/docs/commands/zset/zmscore.mdx +34 -0
- package/docs/commands/zset/zpopmax.mdx +25 -0
- package/docs/commands/zset/zpopmin.mdx +25 -0
- package/docs/commands/zset/zrange.mdx +85 -0
- package/docs/commands/zset/zrank.mdx +29 -0
- package/docs/commands/zset/zrem.mdx +33 -0
- package/docs/commands/zset/zremrangebylex.mdx +32 -0
- package/docs/commands/zset/zremrangebyrank.mdx +32 -0
- package/docs/commands/zset/zremrangebyscore.mdx +32 -0
- package/docs/commands/zset/zrevrank.mdx +29 -0
- package/docs/commands/zset/zscan.mdx +58 -0
- package/docs/commands/zset/zscore.mdx +34 -0
- package/docs/commands/zset/zunionstore.mdx +98 -0
- package/docs/deployment.mdx +117 -0
- package/docs/developing.mdx +118 -0
- package/docs/getstarted.mdx +68 -0
- package/docs/overview.mdx +29 -0
- package/docs/pipelining/auto-pipeline.mdx +108 -0
- package/docs/pipelining/pipeline-transaction.mdx +65 -0
- package/docs/retries.mdx +24 -0
- package/docs/troubleshooting.mdx +80 -0
- package/{error-BNzLTXJG.d.mts → error-4e36-PC0.d.mts} +838 -8
- package/{error-BNzLTXJG.d.ts → error-4e36-PC0.d.ts} +838 -8
- package/fastly.d.mts +2 -2
- package/fastly.d.ts +2 -2
- package/fastly.js +557 -4
- package/fastly.mjs +1 -1
- package/nodejs.d.mts +34 -2
- package/nodejs.d.ts +34 -2
- package/nodejs.js +586 -4
- package/nodejs.mjs +30 -1
- package/package.json +16 -5
- package/src/pkg/auto-pipeline.ts +284 -0
- package/src/pkg/commands/append.ts +12 -0
- package/src/pkg/commands/arcount.ts +14 -0
- package/src/pkg/commands/ardel.ts +19 -0
- package/src/pkg/commands/ardelrange.ts +19 -0
- package/src/pkg/commands/arget.ts +17 -0
- package/src/pkg/commands/argetrange.ts +20 -0
- package/src/pkg/commands/argrep.ts +109 -0
- package/src/pkg/commands/arinfo.ts +88 -0
- package/src/pkg/commands/arinsert.ts +24 -0
- package/src/pkg/commands/arlastitems.ts +29 -0
- package/src/pkg/commands/arlen.ts +23 -0
- package/src/pkg/commands/armget.ts +18 -0
- package/src/pkg/commands/armset.ts +26 -0
- package/src/pkg/commands/arnext.ts +20 -0
- package/src/pkg/commands/arop.ts +48 -0
- package/src/pkg/commands/arring.ts +23 -0
- package/src/pkg/commands/arscan.ts +44 -0
- package/src/pkg/commands/arseek.ts +17 -0
- package/src/pkg/commands/arset.ts +20 -0
- package/src/pkg/commands/bitcount.ts +30 -0
- package/src/pkg/commands/bitfield.ts +50 -0
- package/src/pkg/commands/bitop.ts +35 -0
- package/src/pkg/commands/bitpos.ts +15 -0
- package/src/pkg/commands/client_setinfo.ts +17 -0
- package/src/pkg/commands/command.ts +142 -0
- package/src/pkg/commands/copy.ts +22 -0
- package/src/pkg/commands/dbsize.ts +12 -0
- package/src/pkg/commands/decr.ts +12 -0
- package/src/pkg/commands/decrby.ts +12 -0
- package/src/pkg/commands/del.ts +12 -0
- package/src/pkg/commands/echo.ts +12 -0
- package/src/pkg/commands/eval.ts +18 -0
- package/src/pkg/commands/evalRo.ts +18 -0
- package/src/pkg/commands/evalsha.ts +18 -0
- package/src/pkg/commands/evalshaRo.ts +18 -0
- package/src/pkg/commands/exec.ts +23 -0
- package/src/pkg/commands/exists.ts +12 -0
- package/src/pkg/commands/expire.ts +13 -0
- package/src/pkg/commands/expireat.ts +16 -0
- package/src/pkg/commands/fcall.ts +15 -0
- package/src/pkg/commands/fcall_ro.ts +18 -0
- package/src/pkg/commands/flushall.ts +15 -0
- package/src/pkg/commands/flushdb.ts +15 -0
- package/src/pkg/commands/function_delete.ts +12 -0
- package/src/pkg/commands/function_flush.ts +12 -0
- package/src/pkg/commands/function_list.ts +77 -0
- package/src/pkg/commands/function_load.ts +31 -0
- package/src/pkg/commands/function_stats.ts +42 -0
- package/src/pkg/commands/geo_add.ts +54 -0
- package/src/pkg/commands/geo_dist.ts +19 -0
- package/src/pkg/commands/geo_hash.ts +23 -0
- package/src/pkg/commands/geo_pos.ts +39 -0
- package/src/pkg/commands/geo_search.ts +140 -0
- package/src/pkg/commands/geo_search_store.ts +69 -0
- package/src/pkg/commands/get.ts +15 -0
- package/src/pkg/commands/getbit.ts +12 -0
- package/src/pkg/commands/getdel.ts +15 -0
- package/src/pkg/commands/getex.ts +36 -0
- package/src/pkg/commands/getrange.ts +15 -0
- package/src/pkg/commands/getset.ts +15 -0
- package/src/pkg/commands/hdel.ts +12 -0
- package/src/pkg/commands/hexists.ts +12 -0
- package/src/pkg/commands/hexpire.ts +30 -0
- package/src/pkg/commands/hexpireat.ts +30 -0
- package/src/pkg/commands/hexpiretime.ts +13 -0
- package/src/pkg/commands/hget.ts +18 -0
- package/src/pkg/commands/hgetall.ts +44 -0
- package/src/pkg/commands/hgetdel.ts +30 -0
- package/src/pkg/commands/hgetex.ts +56 -0
- package/src/pkg/commands/hincrby.ts +15 -0
- package/src/pkg/commands/hincrbyfloat.ts +15 -0
- package/src/pkg/commands/hkeys.ts +12 -0
- package/src/pkg/commands/hlen.ts +12 -0
- package/src/pkg/commands/hmget.ts +53 -0
- package/src/pkg/commands/hmset.ts +14 -0
- package/src/pkg/commands/hpersist.ts +13 -0
- package/src/pkg/commands/hpexpire.ts +30 -0
- package/src/pkg/commands/hpexpireat.ts +30 -0
- package/src/pkg/commands/hpexpiretime.ts +13 -0
- package/src/pkg/commands/hpttl.ts +13 -0
- package/src/pkg/commands/hrandfield.ts +52 -0
- package/src/pkg/commands/hscan.ts +31 -0
- package/src/pkg/commands/hset.ts +15 -0
- package/src/pkg/commands/hsetex.ts +59 -0
- package/src/pkg/commands/hsetnx.ts +15 -0
- package/src/pkg/commands/hstrlen.ts +12 -0
- package/src/pkg/commands/httl.ts +13 -0
- package/src/pkg/commands/hvals.ts +12 -0
- package/src/pkg/commands/incr.ts +12 -0
- package/src/pkg/commands/incrby.ts +12 -0
- package/src/pkg/commands/incrbyfloat.ts +12 -0
- package/src/pkg/commands/json_arrappend.ts +18 -0
- package/src/pkg/commands/json_arrindex.ts +15 -0
- package/src/pkg/commands/json_arrinsert.ts +18 -0
- package/src/pkg/commands/json_arrlen.ts +15 -0
- package/src/pkg/commands/json_arrpop.ts +15 -0
- package/src/pkg/commands/json_arrtrim.ts +19 -0
- package/src/pkg/commands/json_clear.ts +12 -0
- package/src/pkg/commands/json_del.ts +12 -0
- package/src/pkg/commands/json_forget.ts +12 -0
- package/src/pkg/commands/json_get.ts +45 -0
- package/src/pkg/commands/json_merge.ts +18 -0
- package/src/pkg/commands/json_mget.ts +12 -0
- package/src/pkg/commands/json_mset.ts +27 -0
- package/src/pkg/commands/json_numincrby.ts +15 -0
- package/src/pkg/commands/json_nummultby.ts +15 -0
- package/src/pkg/commands/json_objkeys.ts +15 -0
- package/src/pkg/commands/json_objlen.ts +15 -0
- package/src/pkg/commands/json_resp.ts +11 -0
- package/src/pkg/commands/json_set.ts +35 -0
- package/src/pkg/commands/json_strappend.ts +15 -0
- package/src/pkg/commands/json_strlen.ts +15 -0
- package/src/pkg/commands/json_toggle.ts +12 -0
- package/src/pkg/commands/json_type.ts +12 -0
- package/src/pkg/commands/keys.ts +12 -0
- package/src/pkg/commands/lindex.ts +11 -0
- package/src/pkg/commands/linsert.ts +10 -0
- package/src/pkg/commands/llen.ts +12 -0
- package/src/pkg/commands/lmove.ts +20 -0
- package/src/pkg/commands/lmpop.ts +19 -0
- package/src/pkg/commands/lpop.ts +18 -0
- package/src/pkg/commands/lpos.ts +26 -0
- package/src/pkg/commands/lpush.ts +12 -0
- package/src/pkg/commands/lpushx.ts +12 -0
- package/src/pkg/commands/lrange.ts +11 -0
- package/src/pkg/commands/lrem.ts +10 -0
- package/src/pkg/commands/lset.ts +8 -0
- package/src/pkg/commands/ltrim.ts +8 -0
- package/src/pkg/commands/mget.ts +15 -0
- package/src/pkg/commands/mod.ts +222 -0
- package/src/pkg/commands/mset.ts +12 -0
- package/src/pkg/commands/msetnx.ts +12 -0
- package/src/pkg/commands/persist.ts +12 -0
- package/src/pkg/commands/pexpire.ts +16 -0
- package/src/pkg/commands/pexpireat.ts +16 -0
- package/src/pkg/commands/pfadd.ts +11 -0
- package/src/pkg/commands/pfcount.ts +11 -0
- package/src/pkg/commands/pfmerge.ts +11 -0
- package/src/pkg/commands/ping.ts +15 -0
- package/src/pkg/commands/psetex.ts +14 -0
- package/src/pkg/commands/psubscribe.ts +26 -0
- package/src/pkg/commands/pttl.ts +12 -0
- package/src/pkg/commands/publish.ts +12 -0
- package/src/pkg/commands/randomkey.ts +12 -0
- package/src/pkg/commands/rename.ts +12 -0
- package/src/pkg/commands/renamenx.ts +12 -0
- package/src/pkg/commands/rpop.ts +21 -0
- package/src/pkg/commands/rpush.ts +12 -0
- package/src/pkg/commands/rpushx.ts +12 -0
- package/src/pkg/commands/sadd.ts +15 -0
- package/src/pkg/commands/scan.ts +63 -0
- package/src/pkg/commands/scard.ts +11 -0
- package/src/pkg/commands/script_exists.ts +15 -0
- package/src/pkg/commands/script_flush.ts +22 -0
- package/src/pkg/commands/script_load.ts +12 -0
- package/src/pkg/commands/sdiff.ts +11 -0
- package/src/pkg/commands/sdiffstore.ts +14 -0
- package/src/pkg/commands/search/command-builder.ts +162 -0
- package/src/pkg/commands/search/index.ts +4 -0
- package/src/pkg/commands/search/schema-builder.ts +320 -0
- package/src/pkg/commands/search/search.ts +218 -0
- package/src/pkg/commands/search/types.ts +1029 -0
- package/src/pkg/commands/search/utils.ts +275 -0
- package/src/pkg/commands/set.ts +52 -0
- package/src/pkg/commands/setbit.ts +15 -0
- package/src/pkg/commands/setex.ts +11 -0
- package/src/pkg/commands/setnx.ts +11 -0
- package/src/pkg/commands/setrange.ts +15 -0
- package/src/pkg/commands/sinter.ts +11 -0
- package/src/pkg/commands/sintercard.ts +19 -0
- package/src/pkg/commands/sinterstore.ts +14 -0
- package/src/pkg/commands/sismember.ts +11 -0
- package/src/pkg/commands/smembers.ts +12 -0
- package/src/pkg/commands/smismember.ts +17 -0
- package/src/pkg/commands/smove.ts +14 -0
- package/src/pkg/commands/spop.ts +18 -0
- package/src/pkg/commands/srandmember.ts +18 -0
- package/src/pkg/commands/srem.ts +11 -0
- package/src/pkg/commands/sscan.ts +31 -0
- package/src/pkg/commands/strlen.ts +12 -0
- package/src/pkg/commands/subscribe.ts +254 -0
- package/src/pkg/commands/sunion.ts +12 -0
- package/src/pkg/commands/sunionstore.ts +15 -0
- package/src/pkg/commands/time.ts +10 -0
- package/src/pkg/commands/touch.ts +12 -0
- package/src/pkg/commands/ttl.ts +12 -0
- package/src/pkg/commands/type.ts +13 -0
- package/src/pkg/commands/types.ts +201 -0
- package/src/pkg/commands/unlink.ts +12 -0
- package/src/pkg/commands/vector/index.ts +11 -0
- package/src/pkg/commands/vector/types.ts +63 -0
- package/src/pkg/commands/vector/utils.ts +67 -0
- package/src/pkg/commands/vector/vector.ts +131 -0
- package/src/pkg/commands/vector_add.ts +18 -0
- package/src/pkg/commands/vector_count.ts +11 -0
- package/src/pkg/commands/vector_create.ts +28 -0
- package/src/pkg/commands/vector_del.ts +13 -0
- package/src/pkg/commands/vector_drop.ts +13 -0
- package/src/pkg/commands/vector_get.ts +18 -0
- package/src/pkg/commands/vector_info.ts +25 -0
- package/src/pkg/commands/vector_query.ts +24 -0
- package/src/pkg/commands/xack.ts +16 -0
- package/src/pkg/commands/xackdel.ts +21 -0
- package/src/pkg/commands/xadd.ts +70 -0
- package/src/pkg/commands/xautoclaim.ts +31 -0
- package/src/pkg/commands/xclaim.ts +56 -0
- package/src/pkg/commands/xdel.ts +16 -0
- package/src/pkg/commands/xdelex.ts +25 -0
- package/src/pkg/commands/xgroup.ts +101 -0
- package/src/pkg/commands/xinfo.ts +28 -0
- package/src/pkg/commands/xlen.ts +12 -0
- package/src/pkg/commands/xpending.ts +44 -0
- package/src/pkg/commands/xrange.ts +49 -0
- package/src/pkg/commands/xread.ts +78 -0
- package/src/pkg/commands/xreadgroup.ts +74 -0
- package/src/pkg/commands/xrevrange.ts +48 -0
- package/src/pkg/commands/xtrim.ts +25 -0
- package/src/pkg/commands/zadd.ts +54 -0
- package/src/pkg/commands/zcard.ts +12 -0
- package/src/pkg/commands/zcount.ts +14 -0
- package/src/pkg/commands/zdiffstore.ts +15 -0
- package/src/pkg/commands/zincrby.ts +14 -0
- package/src/pkg/commands/zinterstore.ts +51 -0
- package/src/pkg/commands/zlexcount.ts +11 -0
- package/src/pkg/commands/zmscore.ts +16 -0
- package/src/pkg/commands/zpopmax.ts +18 -0
- package/src/pkg/commands/zpopmin.ts +18 -0
- package/src/pkg/commands/zrange.ts +72 -0
- package/src/pkg/commands/zrank.ts +14 -0
- package/src/pkg/commands/zrem.ts +11 -0
- package/src/pkg/commands/zremrangebylex.ts +11 -0
- package/src/pkg/commands/zremrangebyrank.ts +14 -0
- package/src/pkg/commands/zremrangebyscore.ts +18 -0
- package/src/pkg/commands/zrevrank.ts +14 -0
- package/src/pkg/commands/zscan.ts +31 -0
- package/src/pkg/commands/zscore.ts +15 -0
- package/src/pkg/commands/zunion.ts +54 -0
- package/src/pkg/commands/zunionstore.ts +52 -0
- package/src/pkg/error.ts +28 -0
- package/src/pkg/http.ts +458 -0
- package/src/pkg/index.ts +1 -0
- package/src/pkg/pipeline.ts +2041 -0
- package/src/pkg/redis.ts +2130 -0
- package/src/pkg/script.ts +100 -0
- package/src/pkg/scriptRo.ts +98 -0
- package/src/pkg/types.ts +35 -0
- package/src/pkg/util.ts +115 -0
- package/src/platforms/cloudflare.ts +162 -0
- package/src/platforms/fastly.ts +105 -0
- package/src/platforms/nodejs.ts +231 -0
- package/src/version.ts +1 -0
|
@@ -194,6 +194,7 @@ declare class Command<TResult, TData> {
|
|
|
194
194
|
type Type = "string" | "list" | "set" | "zset" | "hash" | "none";
|
|
195
195
|
/**
|
|
196
196
|
* @see https://redis.io/commands/type
|
|
197
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/type.mdx
|
|
197
198
|
*/
|
|
198
199
|
declare class TypeCommand extends Command<Type, Type> {
|
|
199
200
|
constructor(cmd: [key: string], opts?: CommandOptions<Type, Type>);
|
|
@@ -236,6 +237,7 @@ type RawArInfo = unknown[] | Record<string, unknown>;
|
|
|
236
237
|
* Describes how an array is laid out in memory. Throws if the key does not exist.
|
|
237
238
|
*
|
|
238
239
|
* @see https://upstash.com/docs/redis/commands/array/arinfo
|
|
240
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arinfo.mdx
|
|
239
241
|
*/
|
|
240
242
|
declare class ArInfoCommand extends Command<RawArInfo, ArInfoResult> {
|
|
241
243
|
constructor([key, opts]: [key: string, opts?: ArInfoOptions], cmdOpts?: CommandOptions<RawArInfo, ArInfoResult>);
|
|
@@ -295,6 +297,7 @@ type ArGrepResult<TData, TOpts extends ArGrepOptions> = TOpts extends {
|
|
|
295
297
|
* and highest possible index.
|
|
296
298
|
*
|
|
297
299
|
* @see https://upstash.com/docs/redis/commands/array/argrep
|
|
300
|
+
* @see node_modules/@upstash/redis/docs/commands/array/argrep.mdx
|
|
298
301
|
*/
|
|
299
302
|
declare class ArGrepCommand<TData = string, TOpts extends ArGrepOptions = ArGrepOptions> extends Command<unknown[], ArGrepResult<TData, TOpts>> {
|
|
300
303
|
constructor([key, start, end, opts]: [
|
|
@@ -428,7 +431,7 @@ declare class VectorIndex {
|
|
|
428
431
|
drop(): Promise<0 | 1>;
|
|
429
432
|
}
|
|
430
433
|
|
|
431
|
-
declare const FIELD_TYPES: readonly ["TEXT", "U64", "I64", "F64", "BOOL", "DATE", "KEYWORD", "FACET"];
|
|
434
|
+
declare const FIELD_TYPES: readonly ["TEXT", "U64", "I64", "F64", "BOOL", "DATE", "KEYWORD", "FACET", "HYBRID"];
|
|
432
435
|
type FieldType = (typeof FIELD_TYPES)[number];
|
|
433
436
|
type TextField = {
|
|
434
437
|
type: "TEXT";
|
|
@@ -457,7 +460,17 @@ type KeywordField = {
|
|
|
457
460
|
type FacetField = {
|
|
458
461
|
type: "FACET";
|
|
459
462
|
};
|
|
460
|
-
|
|
463
|
+
/**
|
|
464
|
+
* A TEXT field that also stores a vector embedding, so it can be searched by meaning with `$ann`.
|
|
465
|
+
*
|
|
466
|
+
* @see https://upstash.com/docs/redis/search/hybrid-search
|
|
467
|
+
*/
|
|
468
|
+
type HybridField = {
|
|
469
|
+
type: "HYBRID";
|
|
470
|
+
noStem?: boolean;
|
|
471
|
+
from?: string;
|
|
472
|
+
};
|
|
473
|
+
type DetailedField = TextField | HybridField | NumericField | BoolField | DateField | KeywordField | FacetField;
|
|
461
474
|
type NestedIndexSchema = {
|
|
462
475
|
[key: string]: FieldType | DetailedField | NestedIndexSchema;
|
|
463
476
|
};
|
|
@@ -471,7 +484,7 @@ type ExtractFieldType<T> = T extends FieldType ? T : T extends {
|
|
|
471
484
|
type: infer U;
|
|
472
485
|
} ? U extends FieldType ? U : never : never;
|
|
473
486
|
type GetFieldAtPath<TSchema, Path extends string> = Path extends `${infer First}.${infer Rest}` ? First extends keyof TSchema ? GetFieldAtPath<TSchema[First], Rest> : never : Path extends keyof TSchema ? TSchema[Path] : never;
|
|
474
|
-
type FieldValueType<T extends FieldType> = T extends "TEXT" ? string : T extends "U64" | "I64" | "F64" ? number : T extends "BOOL" ? boolean : T extends "DATE" ? string : T extends "KEYWORD" ? string : T extends "FACET" ? string : never;
|
|
487
|
+
type FieldValueType<T extends FieldType> = T extends "TEXT" | "HYBRID" ? string : T extends "U64" | "I64" | "F64" ? number : T extends "BOOL" ? boolean : T extends "DATE" ? string : T extends "KEYWORD" ? string : T extends "FACET" ? string : never;
|
|
475
488
|
type GetFieldValueType<TSchema, Path extends string> = GetFieldAtPath<TSchema, Path> extends infer Field ? Field extends FieldType | DetailedField ? FieldValueType<ExtractFieldType<Field>> : never : never;
|
|
476
489
|
type HasFrom<T> = T extends {
|
|
477
490
|
from: string;
|
|
@@ -495,7 +508,7 @@ type QueryOptions<TSchema extends NestedIndexSchema | FlatIndexSchema> = IsDefau
|
|
|
495
508
|
orderBy?: Record<string, "ASC" | "DESC">;
|
|
496
509
|
scoreFunc?: ScoreBy<string>;
|
|
497
510
|
} : {
|
|
498
|
-
filter?: RootQueryFilter<TSchema>;
|
|
511
|
+
filter?: RootQueryFilter<TSchema> | Retriever<TSchema>;
|
|
499
512
|
/** Maximum number of results to return */
|
|
500
513
|
limit?: number;
|
|
501
514
|
/** Number of results to skip */
|
|
@@ -673,7 +686,7 @@ type FacetOperations = {
|
|
|
673
686
|
$boost?: number;
|
|
674
687
|
};
|
|
675
688
|
}[keyof FacetOperationMap<string>];
|
|
676
|
-
type OperationsForFieldType<T extends FieldType> = T extends "TEXT" ? StringOperations : T extends "U64" | "I64" | "F64" ? NumberOperations : T extends "BOOL" ? BooleanOperations : T extends "DATE" ? DateOperations : T extends "KEYWORD" ? KeywordOperations : T extends "FACET" ? FacetOperations : never;
|
|
689
|
+
type OperationsForFieldType<T extends FieldType> = T extends "TEXT" | "HYBRID" ? StringOperations : T extends "U64" | "I64" | "F64" ? NumberOperations : T extends "BOOL" ? BooleanOperations : T extends "DATE" ? DateOperations : T extends "KEYWORD" ? KeywordOperations : T extends "FACET" ? FacetOperations : never;
|
|
677
690
|
type PathOperations<TSchema, TPath extends string> = GetFieldAtPath<TSchema, TPath> extends infer Field ? Field extends FieldType | DetailedField ? OperationsForFieldType<ExtractFieldType<Field>> | FieldValueType<ExtractFieldType<Field>> : never : never;
|
|
678
691
|
type QueryLeaf<TSchema> = {
|
|
679
692
|
[K in SchemaPaths<TSchema>]?: PathOperations<TSchema, K>;
|
|
@@ -786,6 +799,62 @@ type RootOrNode<TSchema extends NestedIndexSchema | FlatIndexSchema> = {
|
|
|
786
799
|
$should?: never;
|
|
787
800
|
$mustNot?: QueryFilter<TSchema> | QueryFilter<TSchema>[];
|
|
788
801
|
};
|
|
802
|
+
/**
|
|
803
|
+
* Runs a semantic search on a HYBRID field.
|
|
804
|
+
*
|
|
805
|
+
* @see https://upstash.com/docs/redis/search/retrievers/ann
|
|
806
|
+
*/
|
|
807
|
+
type AnnRetriever<TSchema extends NestedIndexSchema | FlatIndexSchema> = {
|
|
808
|
+
$ann: {
|
|
809
|
+
/** The HYBRID field to search */
|
|
810
|
+
field: IsDefaultSchema<TSchema> extends true ? string : HybridPaths<TSchema>;
|
|
811
|
+
/** The text to search for. Cannot be empty. */
|
|
812
|
+
query: string;
|
|
813
|
+
/** Accuracy and speed trade-off. Defaults to `balanced`. */
|
|
814
|
+
profile?: "fast" | "balanced" | "precise";
|
|
815
|
+
/** Only documents that match this query are returned */
|
|
816
|
+
filter?: RootQueryFilter<TSchema>;
|
|
817
|
+
/** Scales how much the results add to the `$rrf` score. Valid only inside `$rrf`. */
|
|
818
|
+
weight?: number;
|
|
819
|
+
};
|
|
820
|
+
};
|
|
821
|
+
/**
|
|
822
|
+
* Runs one query. Use it inside `$rrf` to set the weight of a query.
|
|
823
|
+
*
|
|
824
|
+
* @see https://upstash.com/docs/redis/search/retrievers/standard
|
|
825
|
+
*/
|
|
826
|
+
type StandardRetriever<TSchema extends NestedIndexSchema | FlatIndexSchema> = {
|
|
827
|
+
$standard: {
|
|
828
|
+
query: RootQueryFilter<TSchema>;
|
|
829
|
+
/** Scales how much the query adds to the `$rrf` score. Valid only inside `$rrf`. */
|
|
830
|
+
weight?: number;
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
/**
|
|
834
|
+
* Merges the results of 2 to 10 retrievers with Reciprocal Rank Fusion.
|
|
835
|
+
*
|
|
836
|
+
* @see https://upstash.com/docs/redis/search/retrievers/rrf
|
|
837
|
+
*/
|
|
838
|
+
type RrfRetriever<TSchema extends NestedIndexSchema | FlatIndexSchema, TAllowAnn extends boolean = true> = {
|
|
839
|
+
$rrf: {
|
|
840
|
+
/** 2 to 10 retrievers to merge */
|
|
841
|
+
retrievers: (RootQueryFilter<TSchema> | StandardRetriever<TSchema> | (TAllowAnn extends true ? AnnRetriever<TSchema> : never))[];
|
|
842
|
+
/** Higher values give lower-ranked results more influence. Defaults to `60`. */
|
|
843
|
+
rankConstant?: number;
|
|
844
|
+
/** The number of results each retriever contributes. Defaults to `LIMIT`. */
|
|
845
|
+
window?: number;
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
type Retriever<TSchema extends NestedIndexSchema | FlatIndexSchema> = AnnRetriever<TSchema> | StandardRetriever<TSchema> | RrfRetriever<TSchema>;
|
|
849
|
+
/**
|
|
850
|
+
* Retrievers accepted by `SEARCH.COUNT` and `SEARCH.AGGREGATE`, which do not support `$ann`.
|
|
851
|
+
*/
|
|
852
|
+
type CountRetriever<TSchema extends NestedIndexSchema | FlatIndexSchema> = StandardRetriever<TSchema> | RrfRetriever<TSchema, false>;
|
|
853
|
+
type HybridPaths<T, Prefix extends string = ""> = {
|
|
854
|
+
[K in keyof T]: K extends string ? T[K] extends "HYBRID" | {
|
|
855
|
+
type: "HYBRID";
|
|
856
|
+
} ? Prefix extends "" ? K : `${Prefix}${K}` : T[K] extends FieldType | DetailedField ? never : T[K] extends object ? HybridPaths<T[K], `${Prefix}${K}.`> : never : never;
|
|
857
|
+
}[keyof T];
|
|
789
858
|
type DescribeFieldInfo = {
|
|
790
859
|
type: FieldType;
|
|
791
860
|
noTokenize?: boolean;
|
|
@@ -815,7 +884,7 @@ type AggregateOptions<TSchema extends NestedIndexSchema | FlatIndexSchema> = IsD
|
|
|
815
884
|
[key: string]: Record<string, any>;
|
|
816
885
|
};
|
|
817
886
|
} : {
|
|
818
|
-
filter?: RootQueryFilter<TSchema>;
|
|
887
|
+
filter?: RootQueryFilter<TSchema> | CountRetriever<TSchema>;
|
|
819
888
|
aggregations: {
|
|
820
889
|
[key: string]: Aggregation<TSchema>;
|
|
821
890
|
};
|
|
@@ -1061,8 +1130,8 @@ declare class SearchIndex<TSchema extends NestedIndexSchema | FlatIndexSchema> {
|
|
|
1061
1130
|
describe(): Promise<IndexDescription<TSchema> | null>;
|
|
1062
1131
|
query<TOpts extends QueryOptions<TSchema>>(options?: TOpts): Promise<QueryResult<TSchema, TOpts>[]>;
|
|
1063
1132
|
aggregate<TOpts extends AggregateOptions<TSchema>>(options: TOpts): Promise<AggregateResult<TSchema, TOpts>>;
|
|
1064
|
-
count({ filter }: {
|
|
1065
|
-
filter: RootQueryFilter<TSchema>;
|
|
1133
|
+
count({ filter, }: {
|
|
1134
|
+
filter: RootQueryFilter<TSchema> | CountRetriever<TSchema>;
|
|
1066
1135
|
}): Promise<{
|
|
1067
1136
|
count: number;
|
|
1068
1137
|
}>;
|
|
@@ -1109,6 +1178,7 @@ type FunctionLoadArgs = {
|
|
|
1109
1178
|
|
|
1110
1179
|
/**
|
|
1111
1180
|
* @see https://redis.io/commands/append
|
|
1181
|
+
* @see node_modules/@upstash/redis/docs/commands/string/append.mdx
|
|
1112
1182
|
*/
|
|
1113
1183
|
declare class AppendCommand extends Command<number, number> {
|
|
1114
1184
|
constructor(cmd: [key: string, value: string], opts?: CommandOptions<number, number>);
|
|
@@ -1118,6 +1188,7 @@ declare class AppendCommand extends Command<number, number> {
|
|
|
1118
1188
|
* Returns the number of occupied slots in an array. A missing key counts as `0`.
|
|
1119
1189
|
*
|
|
1120
1190
|
* @see https://upstash.com/docs/redis/commands/array/arcount
|
|
1191
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arcount.mdx
|
|
1121
1192
|
*/
|
|
1122
1193
|
declare class ArCountCommand extends Command<number, number> {
|
|
1123
1194
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -1129,6 +1200,7 @@ declare class ArCountCommand extends Command<number, number> {
|
|
|
1129
1200
|
* Returns the number of slots that held a value.
|
|
1130
1201
|
*
|
|
1131
1202
|
* @see https://upstash.com/docs/redis/commands/array/ardel
|
|
1203
|
+
* @see node_modules/@upstash/redis/docs/commands/array/ardel.mdx
|
|
1132
1204
|
*/
|
|
1133
1205
|
declare class ArDelCommand extends Command<number, number> {
|
|
1134
1206
|
constructor(cmd: [key: string, ...indexes: (number | string)[]], opts?: CommandOptions<number, number>);
|
|
@@ -1140,6 +1212,7 @@ declare class ArDelCommand extends Command<number, number> {
|
|
|
1140
1212
|
* Returns the total number of values removed across all ranges.
|
|
1141
1213
|
*
|
|
1142
1214
|
* @see https://upstash.com/docs/redis/commands/array/ardelrange
|
|
1215
|
+
* @see node_modules/@upstash/redis/docs/commands/array/ardelrange.mdx
|
|
1143
1216
|
*/
|
|
1144
1217
|
declare class ArDelRangeCommand extends Command<number, number> {
|
|
1145
1218
|
constructor([key, ...ranges]: [key: string, ...ranges: [start: number | string, end: number | string][]], opts?: CommandOptions<number, number>);
|
|
@@ -1149,6 +1222,7 @@ declare class ArDelRangeCommand extends Command<number, number> {
|
|
|
1149
1222
|
* Returns the value stored at `index`, or `null` if the slot is empty or the key does not exist.
|
|
1150
1223
|
*
|
|
1151
1224
|
* @see https://upstash.com/docs/redis/commands/array/arget
|
|
1225
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arget.mdx
|
|
1152
1226
|
*/
|
|
1153
1227
|
declare class ArGetCommand<TData = string> extends Command<unknown | null, TData | null> {
|
|
1154
1228
|
constructor(cmd: [key: string, index: number | string], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -1161,6 +1235,7 @@ declare class ArGetCommand<TData = string> extends Command<unknown | null, TData
|
|
|
1161
1235
|
* Ranges wider than 1,000,000 indexes are rejected by the server.
|
|
1162
1236
|
*
|
|
1163
1237
|
* @see https://upstash.com/docs/redis/commands/array/argetrange
|
|
1238
|
+
* @see node_modules/@upstash/redis/docs/commands/array/argetrange.mdx
|
|
1164
1239
|
*/
|
|
1165
1240
|
declare class ArGetRangeCommand<TData = string> extends Command<unknown[], (TData | null)[]> {
|
|
1166
1241
|
constructor(cmd: [key: string, start: number | string, end: number | string], opts?: CommandOptions<unknown[], (TData | null)[]>);
|
|
@@ -1174,6 +1249,7 @@ declare class ArGetRangeCommand<TData = string> extends Command<unknown[], (TDat
|
|
|
1174
1249
|
* Indexes are returned as strings; see `arlen`.
|
|
1175
1250
|
*
|
|
1176
1251
|
* @see https://upstash.com/docs/redis/commands/array/arinsert
|
|
1252
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arinsert.mdx
|
|
1177
1253
|
*/
|
|
1178
1254
|
declare class ArInsertCommand<TData = string> extends Command<number | string, string> {
|
|
1179
1255
|
constructor(cmd: [key: string, ...values: TData[]], opts?: CommandOptions<number | string, string>);
|
|
@@ -1190,6 +1266,7 @@ type ArLastItemsOptions = {
|
|
|
1190
1266
|
* cursor. Values come back oldest-first unless `rev` is set.
|
|
1191
1267
|
*
|
|
1192
1268
|
* @see https://upstash.com/docs/redis/commands/array/arlastitems
|
|
1269
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arlastitems.mdx
|
|
1193
1270
|
*/
|
|
1194
1271
|
declare class ArLastItemsCommand<TData = string> extends Command<unknown[], (TData | null)[]> {
|
|
1195
1272
|
constructor([key, count, opts]: [key: string, count: number, opts?: ArLastItemsOptions], cmdOpts?: CommandOptions<unknown[], (TData | null)[]>);
|
|
@@ -1205,6 +1282,7 @@ declare class ArLastItemsCommand<TData = string> extends Command<unknown[], (TDa
|
|
|
1205
1282
|
* straight back into any command that takes an index.
|
|
1206
1283
|
*
|
|
1207
1284
|
* @see https://upstash.com/docs/redis/commands/array/arlen
|
|
1285
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arlen.mdx
|
|
1208
1286
|
*/
|
|
1209
1287
|
declare class ArLenCommand extends Command<number | string, string> {
|
|
1210
1288
|
constructor(cmd: [key: string], opts?: CommandOptions<number | string, string>);
|
|
@@ -1215,6 +1293,7 @@ declare class ArLenCommand extends Command<number | string, string> {
|
|
|
1215
1293
|
* empty slots.
|
|
1216
1294
|
*
|
|
1217
1295
|
* @see https://upstash.com/docs/redis/commands/array/armget
|
|
1296
|
+
* @see node_modules/@upstash/redis/docs/commands/array/armget.mdx
|
|
1218
1297
|
*/
|
|
1219
1298
|
declare class ArMGetCommand<TData = string> extends Command<unknown[], (TData | null)[]> {
|
|
1220
1299
|
constructor(cmd: [key: string, ...indexes: (number | string)[]], opts?: CommandOptions<unknown[], (TData | null)[]>);
|
|
@@ -1231,6 +1310,7 @@ type ArMSetValues<TData> = Record<number | string, TData> | [number | string, TD
|
|
|
1231
1310
|
* Returns the number of slots that were newly occupied. Overwriting an existing value contributes `0`.
|
|
1232
1311
|
*
|
|
1233
1312
|
* @see https://upstash.com/docs/redis/commands/array/armset
|
|
1313
|
+
* @see node_modules/@upstash/redis/docs/commands/array/armset.mdx
|
|
1234
1314
|
*/
|
|
1235
1315
|
declare class ArMSetCommand<TData = string> extends Command<number, number> {
|
|
1236
1316
|
constructor([key, values]: [key: string, values: ArMSetValues<TData>], opts?: CommandOptions<number, number>);
|
|
@@ -1243,6 +1323,7 @@ declare class ArMSetCommand<TData = string> extends Command<number, number> {
|
|
|
1243
1323
|
* already at the highest supported index. Indexes are returned as strings; see `arlen`.
|
|
1244
1324
|
*
|
|
1245
1325
|
* @see https://upstash.com/docs/redis/commands/array/arnext
|
|
1326
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arnext.mdx
|
|
1246
1327
|
*/
|
|
1247
1328
|
declare class ArNextCommand extends Command<number | string | null, string | null> {
|
|
1248
1329
|
constructor(cmd: [key: string], opts?: CommandOptions<number | string | null, string | null>);
|
|
@@ -1269,6 +1350,7 @@ type ArOpOperation<TData = string> = ArOpKeyword | Lowercase<ArOpKeyword> | {
|
|
|
1269
1350
|
* lose precision.
|
|
1270
1351
|
*
|
|
1271
1352
|
* @see https://upstash.com/docs/redis/commands/array/arop
|
|
1353
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arop.mdx
|
|
1272
1354
|
*/
|
|
1273
1355
|
declare class ArOpCommand<TData = string> extends Command<string | number | null, number | null> {
|
|
1274
1356
|
constructor([key, start, end, operation]: [
|
|
@@ -1286,6 +1368,7 @@ declare class ArOpCommand<TData = string> extends Command<string | number | null
|
|
|
1286
1368
|
* Returns the index the last value was written to, as a string; see `arlen`.
|
|
1287
1369
|
*
|
|
1288
1370
|
* @see https://upstash.com/docs/redis/commands/array/arring
|
|
1371
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arring.mdx
|
|
1289
1372
|
*/
|
|
1290
1373
|
declare class ArRingCommand<TData = string> extends Command<number | string, string> {
|
|
1291
1374
|
constructor(cmd: [key: string, size: number, ...values: TData[]], opts?: CommandOptions<number | string, string>);
|
|
@@ -1304,6 +1387,7 @@ type ArScanOptions = {
|
|
|
1304
1387
|
* Indexes are returned as strings; see `arlen`.
|
|
1305
1388
|
*
|
|
1306
1389
|
* @see https://upstash.com/docs/redis/commands/array/arscan
|
|
1390
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arscan.mdx
|
|
1307
1391
|
*/
|
|
1308
1392
|
declare class ArScanCommand<TData = string> extends Command<unknown[], [string, TData][]> {
|
|
1309
1393
|
constructor([key, start, end, opts]: [
|
|
@@ -1321,6 +1405,7 @@ declare class ArScanCommand<TData = string> extends Command<unknown[], [string,
|
|
|
1321
1405
|
* Returns `1` if the cursor was moved, `0` if the key does not exist.
|
|
1322
1406
|
*
|
|
1323
1407
|
* @see https://upstash.com/docs/redis/commands/array/arseek
|
|
1408
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arseek.mdx
|
|
1324
1409
|
*/
|
|
1325
1410
|
declare class ArSeekCommand extends Command<0 | 1, 0 | 1> {
|
|
1326
1411
|
constructor(cmd: [key: string, index: number | string], opts?: CommandOptions<0 | 1, 0 | 1>);
|
|
@@ -1333,6 +1418,7 @@ declare class ArSeekCommand extends Command<0 | 1, 0 | 1> {
|
|
|
1333
1418
|
* Returns the number of slots that were newly occupied. Overwriting an existing value contributes `0`.
|
|
1334
1419
|
*
|
|
1335
1420
|
* @see https://upstash.com/docs/redis/commands/array/arset
|
|
1421
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arset.mdx
|
|
1336
1422
|
*/
|
|
1337
1423
|
declare class ArSetCommand<TData = string> extends Command<number, number> {
|
|
1338
1424
|
constructor(cmd: [key: string, index: number | string, ...values: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -1340,6 +1426,7 @@ declare class ArSetCommand<TData = string> extends Command<number, number> {
|
|
|
1340
1426
|
|
|
1341
1427
|
/**
|
|
1342
1428
|
* @see https://redis.io/commands/bitcount
|
|
1429
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitcount.mdx
|
|
1343
1430
|
*/
|
|
1344
1431
|
declare class BitCountCommand extends Command<number, number> {
|
|
1345
1432
|
constructor(cmd: [key: string, start?: never, end?: never], opts?: CommandOptions<number, number>);
|
|
@@ -1370,6 +1457,7 @@ declare class BitFieldCommand<T = Promise<number[]>> {
|
|
|
1370
1457
|
|
|
1371
1458
|
/**
|
|
1372
1459
|
* @see https://redis.io/commands/bitop
|
|
1460
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitop.mdx
|
|
1373
1461
|
*/
|
|
1374
1462
|
declare class BitOpCommand extends Command<number, number> {
|
|
1375
1463
|
constructor(cmd: [op: "and" | "or" | "xor", destinationKey: string, ...sourceKeys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -1380,6 +1468,7 @@ declare class BitOpCommand extends Command<number, number> {
|
|
|
1380
1468
|
|
|
1381
1469
|
/**
|
|
1382
1470
|
* @see https://redis.io/commands/bitpos
|
|
1471
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitpos.mdx
|
|
1383
1472
|
*/
|
|
1384
1473
|
declare class BitPosCommand extends Command<number, number> {
|
|
1385
1474
|
constructor(cmd: [key: string, bit: 0 | 1, start?: number, end?: number], opts?: CommandOptions<number, number>);
|
|
@@ -1388,6 +1477,7 @@ declare class BitPosCommand extends Command<number, number> {
|
|
|
1388
1477
|
type ClientSetInfoAttribute = "LIB-NAME" | "lib-name" | "LIB-VER" | "lib-ver";
|
|
1389
1478
|
/**
|
|
1390
1479
|
* @see https://redis.io/commands/client-setinfo
|
|
1480
|
+
* @see node_modules/@upstash/redis/docs/commands/connection/client_setinfo.mdx
|
|
1391
1481
|
*/
|
|
1392
1482
|
declare class ClientSetInfoCommand extends Command<string, string> {
|
|
1393
1483
|
constructor([attribute, value]: [attribute: ClientSetInfoAttribute, value: string], opts?: CommandOptions<string, string>);
|
|
@@ -1404,6 +1494,7 @@ declare class CopyCommand extends Command<number, "COPIED" | "NOT_COPIED"> {
|
|
|
1404
1494
|
|
|
1405
1495
|
/**
|
|
1406
1496
|
* @see https://redis.io/commands/dbsize
|
|
1497
|
+
* @see node_modules/@upstash/redis/docs/commands/server/dbsize.mdx
|
|
1407
1498
|
*/
|
|
1408
1499
|
declare class DBSizeCommand extends Command<number, number> {
|
|
1409
1500
|
constructor(opts?: CommandOptions<number, number>);
|
|
@@ -1411,6 +1502,7 @@ declare class DBSizeCommand extends Command<number, number> {
|
|
|
1411
1502
|
|
|
1412
1503
|
/**
|
|
1413
1504
|
* @see https://redis.io/commands/decr
|
|
1505
|
+
* @see node_modules/@upstash/redis/docs/commands/string/decr.mdx
|
|
1414
1506
|
*/
|
|
1415
1507
|
declare class DecrCommand extends Command<number, number> {
|
|
1416
1508
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -1418,6 +1510,7 @@ declare class DecrCommand extends Command<number, number> {
|
|
|
1418
1510
|
|
|
1419
1511
|
/**
|
|
1420
1512
|
* @see https://redis.io/commands/decrby
|
|
1513
|
+
* @see node_modules/@upstash/redis/docs/commands/string/decrby.mdx
|
|
1421
1514
|
*/
|
|
1422
1515
|
declare class DecrByCommand extends Command<number, number> {
|
|
1423
1516
|
constructor(cmd: [key: string, decrement: number], opts?: CommandOptions<number, number>);
|
|
@@ -1425,6 +1518,7 @@ declare class DecrByCommand extends Command<number, number> {
|
|
|
1425
1518
|
|
|
1426
1519
|
/**
|
|
1427
1520
|
* @see https://redis.io/commands/del
|
|
1521
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/del.mdx
|
|
1428
1522
|
*/
|
|
1429
1523
|
declare class DelCommand extends Command<number, number> {
|
|
1430
1524
|
constructor(cmd: [...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -1432,6 +1526,7 @@ declare class DelCommand extends Command<number, number> {
|
|
|
1432
1526
|
|
|
1433
1527
|
/**
|
|
1434
1528
|
* @see https://redis.io/commands/echo
|
|
1529
|
+
* @see node_modules/@upstash/redis/docs/commands/auth/echo.mdx
|
|
1435
1530
|
*/
|
|
1436
1531
|
declare class EchoCommand extends Command<string, string> {
|
|
1437
1532
|
constructor(cmd: [message: string], opts?: CommandOptions<string, string>);
|
|
@@ -1439,6 +1534,10 @@ declare class EchoCommand extends Command<string, string> {
|
|
|
1439
1534
|
|
|
1440
1535
|
/**
|
|
1441
1536
|
* @see https://redis.io/commands/eval_ro
|
|
1537
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/eval_ro.mdx
|
|
1538
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1539
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1540
|
+
* to receive raw strings.
|
|
1442
1541
|
*/
|
|
1443
1542
|
declare class EvalROCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
|
|
1444
1543
|
constructor([script, keys, args]: [script: string, keys: string[], args: TArgs], opts?: CommandOptions<unknown, TData>);
|
|
@@ -1446,6 +1545,10 @@ declare class EvalROCommand<TArgs extends unknown[], TData> extends Command<unkn
|
|
|
1446
1545
|
|
|
1447
1546
|
/**
|
|
1448
1547
|
* @see https://redis.io/commands/eval
|
|
1548
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/eval.mdx
|
|
1549
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1550
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1551
|
+
* to receive raw strings.
|
|
1449
1552
|
*/
|
|
1450
1553
|
declare class EvalCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
|
|
1451
1554
|
constructor([script, keys, args]: [script: string, keys: string[], args: TArgs], opts?: CommandOptions<unknown, TData>);
|
|
@@ -1453,6 +1556,10 @@ declare class EvalCommand<TArgs extends unknown[], TData> extends Command<unknow
|
|
|
1453
1556
|
|
|
1454
1557
|
/**
|
|
1455
1558
|
* @see https://redis.io/commands/evalsha_ro
|
|
1559
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/evalsha_ro.mdx
|
|
1560
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1561
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1562
|
+
* to receive raw strings.
|
|
1456
1563
|
*/
|
|
1457
1564
|
declare class EvalshaROCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
|
|
1458
1565
|
constructor([sha, keys, args]: [sha: string, keys: string[], args?: TArgs], opts?: CommandOptions<unknown, TData>);
|
|
@@ -1460,6 +1567,10 @@ declare class EvalshaROCommand<TArgs extends unknown[], TData> extends Command<u
|
|
|
1460
1567
|
|
|
1461
1568
|
/**
|
|
1462
1569
|
* @see https://redis.io/commands/evalsha
|
|
1570
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/evalsha.mdx
|
|
1571
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1572
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1573
|
+
* to receive raw strings.
|
|
1463
1574
|
*/
|
|
1464
1575
|
declare class EvalshaCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
|
|
1465
1576
|
constructor([sha, keys, args]: [sha: string, keys: string[], args?: TArgs], opts?: CommandOptions<unknown, TData>);
|
|
@@ -1467,6 +1578,7 @@ declare class EvalshaCommand<TArgs extends unknown[], TData> extends Command<unk
|
|
|
1467
1578
|
|
|
1468
1579
|
/**
|
|
1469
1580
|
* @see https://redis.io/commands/exists
|
|
1581
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/exists.mdx
|
|
1470
1582
|
*/
|
|
1471
1583
|
declare class ExistsCommand extends Command<number, number> {
|
|
1472
1584
|
constructor(cmd: [...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -1479,6 +1591,7 @@ declare class ExpireCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
1479
1591
|
|
|
1480
1592
|
/**
|
|
1481
1593
|
* @see https://redis.io/commands/expireat
|
|
1594
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/expireat.mdx
|
|
1482
1595
|
*/
|
|
1483
1596
|
declare class ExpireAtCommand extends Command<"0" | "1", 0 | 1> {
|
|
1484
1597
|
constructor(cmd: [key: string, unix: number, option?: ExpireOption], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -1486,6 +1599,7 @@ declare class ExpireAtCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
1486
1599
|
|
|
1487
1600
|
/**
|
|
1488
1601
|
* @see https://redis.io/commands/flushall
|
|
1602
|
+
* @see node_modules/@upstash/redis/docs/commands/server/flushall.mdx
|
|
1489
1603
|
*/
|
|
1490
1604
|
declare class FlushAllCommand extends Command<"OK", "OK"> {
|
|
1491
1605
|
constructor(args?: [{
|
|
@@ -1495,6 +1609,7 @@ declare class FlushAllCommand extends Command<"OK", "OK"> {
|
|
|
1495
1609
|
|
|
1496
1610
|
/**
|
|
1497
1611
|
* @see https://redis.io/commands/flushdb
|
|
1612
|
+
* @see node_modules/@upstash/redis/docs/commands/server/flushdb.mdx
|
|
1498
1613
|
*/
|
|
1499
1614
|
declare class FlushDBCommand extends Command<"OK", "OK"> {
|
|
1500
1615
|
constructor([opts]: [opts?: {
|
|
@@ -1662,6 +1777,10 @@ declare class GeoSearchStoreCommand<TMemberType = string, TOptions extends GeoSe
|
|
|
1662
1777
|
|
|
1663
1778
|
/**
|
|
1664
1779
|
* @see https://redis.io/commands/get
|
|
1780
|
+
* @see node_modules/@upstash/redis/docs/commands/string/get.mdx
|
|
1781
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1782
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1783
|
+
* to receive raw strings.
|
|
1665
1784
|
*/
|
|
1666
1785
|
declare class GetCommand<TData = string> extends Command<unknown | null, TData | null> {
|
|
1667
1786
|
constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -1669,6 +1788,7 @@ declare class GetCommand<TData = string> extends Command<unknown | null, TData |
|
|
|
1669
1788
|
|
|
1670
1789
|
/**
|
|
1671
1790
|
* @see https://redis.io/commands/getbit
|
|
1791
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/getbit.mdx
|
|
1672
1792
|
*/
|
|
1673
1793
|
declare class GetBitCommand extends Command<"0" | "1", 0 | 1> {
|
|
1674
1794
|
constructor(cmd: [key: string, offset: number], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -1676,6 +1796,10 @@ declare class GetBitCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
1676
1796
|
|
|
1677
1797
|
/**
|
|
1678
1798
|
* @see https://redis.io/commands/getdel
|
|
1799
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getdel.mdx
|
|
1800
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1801
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1802
|
+
* to receive raw strings.
|
|
1679
1803
|
*/
|
|
1680
1804
|
declare class GetDelCommand<TData = string> extends Command<unknown | null, TData | null> {
|
|
1681
1805
|
constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -1727,6 +1851,7 @@ declare class GetExCommand<TData = string> extends Command<unknown | null, TData
|
|
|
1727
1851
|
|
|
1728
1852
|
/**
|
|
1729
1853
|
* @see https://redis.io/commands/getrange
|
|
1854
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getrange.mdx
|
|
1730
1855
|
*/
|
|
1731
1856
|
declare class GetRangeCommand extends Command<string, string> {
|
|
1732
1857
|
constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<string, string>);
|
|
@@ -1734,6 +1859,7 @@ declare class GetRangeCommand extends Command<string, string> {
|
|
|
1734
1859
|
|
|
1735
1860
|
/**
|
|
1736
1861
|
* @see https://redis.io/commands/getset
|
|
1862
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getset.mdx
|
|
1737
1863
|
*/
|
|
1738
1864
|
declare class GetSetCommand<TData = string> extends Command<unknown | null, TData | null> {
|
|
1739
1865
|
constructor(cmd: [key: string, value: TData], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -1741,6 +1867,7 @@ declare class GetSetCommand<TData = string> extends Command<unknown | null, TDat
|
|
|
1741
1867
|
|
|
1742
1868
|
/**
|
|
1743
1869
|
* @see https://redis.io/commands/hdel
|
|
1870
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hdel.mdx
|
|
1744
1871
|
*/
|
|
1745
1872
|
declare class HDelCommand extends Command<"0" | "1", 0 | 1> {
|
|
1746
1873
|
constructor(cmd: [key: string, ...fields: string[]], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -1748,6 +1875,7 @@ declare class HDelCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
1748
1875
|
|
|
1749
1876
|
/**
|
|
1750
1877
|
* @see https://redis.io/commands/hexists
|
|
1878
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexists.mdx
|
|
1751
1879
|
*/
|
|
1752
1880
|
declare class HExistsCommand extends Command<number, number> {
|
|
1753
1881
|
constructor(cmd: [key: string, field: string], opts?: CommandOptions<number, number>);
|
|
@@ -1807,6 +1935,10 @@ declare class HPTtlCommand extends Command<number[], number[]> {
|
|
|
1807
1935
|
|
|
1808
1936
|
/**
|
|
1809
1937
|
* @see https://redis.io/commands/hget
|
|
1938
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hget.mdx
|
|
1939
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1940
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1941
|
+
* to receive raw strings.
|
|
1810
1942
|
*/
|
|
1811
1943
|
declare class HGetCommand<TData> extends Command<unknown | null, TData | null> {
|
|
1812
1944
|
constructor(cmd: [key: string, field: string], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -1814,6 +1946,12 @@ declare class HGetCommand<TData> extends Command<unknown | null, TData | null> {
|
|
|
1814
1946
|
|
|
1815
1947
|
/**
|
|
1816
1948
|
* @see https://redis.io/commands/hgetall
|
|
1949
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetall.mdx
|
|
1950
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
1951
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
1952
|
+
* to receive raw strings.
|
|
1953
|
+
* With automaticDeserialization: false, hgetall returns a flat array instead, such as
|
|
1954
|
+
* ["text", "123", "version", "1"], and [] for a missing key.
|
|
1817
1955
|
*/
|
|
1818
1956
|
declare class HGetAllCommand<TData extends Record<string, unknown>> extends Command<unknown | null, TData | null> {
|
|
1819
1957
|
constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -1829,6 +1967,7 @@ declare class HGetAllCommand<TData extends Record<string, unknown>> extends Comm
|
|
|
1829
1967
|
* In case all fields are non-existent or the hash doesn't exist, `null` is returned
|
|
1830
1968
|
*
|
|
1831
1969
|
* @see https://redis.io/commands/hgetdel
|
|
1970
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetdel.mdx
|
|
1832
1971
|
*/
|
|
1833
1972
|
declare class HGetDelCommand<TData extends Record<string, unknown>> extends Command<(string | null)[], TData | null> {
|
|
1834
1973
|
constructor([key, ...fields]: [key: string, ...fields: (string | number)[]], opts?: CommandOptions<(string | null)[], TData | null>);
|
|
@@ -1875,6 +2014,7 @@ type HGetExCommandOptions = {
|
|
|
1875
2014
|
* In case all fields are non-existent or the hash doesn't exist, `null` is returned
|
|
1876
2015
|
*
|
|
1877
2016
|
* @see https://redis.io/commands/hgetex
|
|
2017
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetex.mdx
|
|
1878
2018
|
*/
|
|
1879
2019
|
declare class HGetExCommand<TData extends Record<string, unknown>> extends Command<(string | null)[], TData | null> {
|
|
1880
2020
|
constructor([key, opts, ...fields]: [
|
|
@@ -1886,6 +2026,7 @@ declare class HGetExCommand<TData extends Record<string, unknown>> extends Comma
|
|
|
1886
2026
|
|
|
1887
2027
|
/**
|
|
1888
2028
|
* @see https://redis.io/commands/hincrby
|
|
2029
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hincrby.mdx
|
|
1889
2030
|
*/
|
|
1890
2031
|
declare class HIncrByCommand extends Command<number, number> {
|
|
1891
2032
|
constructor(cmd: [key: string, field: string, increment: number], opts?: CommandOptions<number, number>);
|
|
@@ -1893,6 +2034,7 @@ declare class HIncrByCommand extends Command<number, number> {
|
|
|
1893
2034
|
|
|
1894
2035
|
/**
|
|
1895
2036
|
* @see https://redis.io/commands/hincrbyfloat
|
|
2037
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hincrbyfloat.mdx
|
|
1896
2038
|
*/
|
|
1897
2039
|
declare class HIncrByFloatCommand extends Command<number, number> {
|
|
1898
2040
|
constructor(cmd: [key: string, field: string, increment: number], opts?: CommandOptions<number, number>);
|
|
@@ -1900,6 +2042,7 @@ declare class HIncrByFloatCommand extends Command<number, number> {
|
|
|
1900
2042
|
|
|
1901
2043
|
/**
|
|
1902
2044
|
* @see https://redis.io/commands/hkeys
|
|
2045
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hkeys.mdx
|
|
1903
2046
|
*/
|
|
1904
2047
|
declare class HKeysCommand extends Command<string[], string[]> {
|
|
1905
2048
|
constructor([key]: [key: string], opts?: CommandOptions<string[], string[]>);
|
|
@@ -1907,6 +2050,7 @@ declare class HKeysCommand extends Command<string[], string[]> {
|
|
|
1907
2050
|
|
|
1908
2051
|
/**
|
|
1909
2052
|
* @see https://redis.io/commands/hlen
|
|
2053
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hlen.mdx
|
|
1910
2054
|
*/
|
|
1911
2055
|
declare class HLenCommand extends Command<number, number> {
|
|
1912
2056
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -1922,6 +2066,12 @@ declare class HLenCommand extends Command<number, number> {
|
|
|
1922
2066
|
* In case the hash does not exist or all fields are empty `null` is returned
|
|
1923
2067
|
*
|
|
1924
2068
|
* @see https://redis.io/commands/hmget
|
|
2069
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hmget.mdx
|
|
2070
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
2071
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
2072
|
+
* to receive raw strings.
|
|
2073
|
+
* With automaticDeserialization: false, hmget returns an array of values in field order instead,
|
|
2074
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
1925
2075
|
*/
|
|
1926
2076
|
declare class HMGetCommand<TData extends Record<string, unknown>> extends Command<(string | null)[], TData | null> {
|
|
1927
2077
|
constructor([key, ...fields]: [key: string, ...fields: string[]], opts?: CommandOptions<(string | null)[], TData | null>);
|
|
@@ -1936,6 +2086,7 @@ declare class HMSetCommand<TData> extends Command<"OK", "OK"> {
|
|
|
1936
2086
|
|
|
1937
2087
|
/**
|
|
1938
2088
|
* @see https://redis.io/commands/hrandfield
|
|
2089
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hrandfield.mdx
|
|
1939
2090
|
*/
|
|
1940
2091
|
declare class HRandFieldCommand<TData extends string | string[] | Record<string, unknown>> extends Command<string | string[], TData> {
|
|
1941
2092
|
constructor(cmd: [key: string], opts?: CommandOptions<string, string>);
|
|
@@ -1971,6 +2122,7 @@ type ScanResultWithType = [string, {
|
|
|
1971
2122
|
}[]];
|
|
1972
2123
|
/**
|
|
1973
2124
|
* @see https://redis.io/commands/scan
|
|
2125
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/scan.mdx
|
|
1974
2126
|
*/
|
|
1975
2127
|
declare class ScanCommand<TData = ScanResultStandard> extends Command<[string, string[]], TData> {
|
|
1976
2128
|
constructor([cursor, opts]: [cursor: string | number, opts?: ScanCommandOptions], cmdOpts?: CommandOptions<[string, string[]], TData>);
|
|
@@ -1978,6 +2130,7 @@ declare class ScanCommand<TData = ScanResultStandard> extends Command<[string, s
|
|
|
1978
2130
|
|
|
1979
2131
|
/**
|
|
1980
2132
|
* @see https://redis.io/commands/hscan
|
|
2133
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hscan.mdx
|
|
1981
2134
|
*/
|
|
1982
2135
|
declare class HScanCommand extends Command<[
|
|
1983
2136
|
string,
|
|
@@ -1991,6 +2144,7 @@ declare class HScanCommand extends Command<[
|
|
|
1991
2144
|
|
|
1992
2145
|
/**
|
|
1993
2146
|
* @see https://redis.io/commands/hset
|
|
2147
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hset.mdx
|
|
1994
2148
|
*/
|
|
1995
2149
|
declare class HSetCommand<TData> extends Command<number, number> {
|
|
1996
2150
|
constructor([key, kv]: [key: string, kv: Record<string, TData>], opts?: CommandOptions<number, number>);
|
|
@@ -2043,6 +2197,7 @@ type HSetExCommandOptions = {
|
|
|
2043
2197
|
* Returns 1 on success and 0 otherwise.
|
|
2044
2198
|
*
|
|
2045
2199
|
* @see https://redis.io/commands/hsetex
|
|
2200
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hsetex.mdx
|
|
2046
2201
|
*/
|
|
2047
2202
|
declare class HSetExCommand<TData> extends Command<number, number> {
|
|
2048
2203
|
constructor([key, opts, kv]: [key: string, opts: HSetExCommandOptions, kv: Record<string, TData>], cmdOpts?: CommandOptions<number, number>);
|
|
@@ -2050,6 +2205,7 @@ declare class HSetExCommand<TData> extends Command<number, number> {
|
|
|
2050
2205
|
|
|
2051
2206
|
/**
|
|
2052
2207
|
* @see https://redis.io/commands/hsetnx
|
|
2208
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hsetnx.mdx
|
|
2053
2209
|
*/
|
|
2054
2210
|
declare class HSetNXCommand<TData> extends Command<"0" | "1", 0 | 1> {
|
|
2055
2211
|
constructor(cmd: [key: string, field: string, value: TData], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2057,6 +2213,7 @@ declare class HSetNXCommand<TData> extends Command<"0" | "1", 0 | 1> {
|
|
|
2057
2213
|
|
|
2058
2214
|
/**
|
|
2059
2215
|
* @see https://redis.io/commands/hstrlen
|
|
2216
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hstrlen.mdx
|
|
2060
2217
|
*/
|
|
2061
2218
|
declare class HStrLenCommand extends Command<number, number> {
|
|
2062
2219
|
constructor(cmd: [key: string, field: string], opts?: CommandOptions<number, number>);
|
|
@@ -2068,6 +2225,7 @@ declare class HTtlCommand extends Command<number[], number[]> {
|
|
|
2068
2225
|
|
|
2069
2226
|
/**
|
|
2070
2227
|
* @see https://redis.io/commands/hvals
|
|
2228
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hvals.mdx
|
|
2071
2229
|
*/
|
|
2072
2230
|
declare class HValsCommand<TData extends unknown[]> extends Command<unknown[], TData> {
|
|
2073
2231
|
constructor(cmd: [key: string], opts?: CommandOptions<unknown[], TData>);
|
|
@@ -2075,6 +2233,7 @@ declare class HValsCommand<TData extends unknown[]> extends Command<unknown[], T
|
|
|
2075
2233
|
|
|
2076
2234
|
/**
|
|
2077
2235
|
* @see https://redis.io/commands/incr
|
|
2236
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incr.mdx
|
|
2078
2237
|
*/
|
|
2079
2238
|
declare class IncrCommand extends Command<number, number> {
|
|
2080
2239
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -2082,6 +2241,7 @@ declare class IncrCommand extends Command<number, number> {
|
|
|
2082
2241
|
|
|
2083
2242
|
/**
|
|
2084
2243
|
* @see https://redis.io/commands/incrby
|
|
2244
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incrby.mdx
|
|
2085
2245
|
*/
|
|
2086
2246
|
declare class IncrByCommand extends Command<number, number> {
|
|
2087
2247
|
constructor(cmd: [key: string, value: number], opts?: CommandOptions<number, number>);
|
|
@@ -2089,6 +2249,7 @@ declare class IncrByCommand extends Command<number, number> {
|
|
|
2089
2249
|
|
|
2090
2250
|
/**
|
|
2091
2251
|
* @see https://redis.io/commands/incrbyfloat
|
|
2252
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incrbyfloat.mdx
|
|
2092
2253
|
*/
|
|
2093
2254
|
declare class IncrByFloatCommand extends Command<number, number> {
|
|
2094
2255
|
constructor(cmd: [key: string, value: number], opts?: CommandOptions<number, number>);
|
|
@@ -2096,6 +2257,7 @@ declare class IncrByFloatCommand extends Command<number, number> {
|
|
|
2096
2257
|
|
|
2097
2258
|
/**
|
|
2098
2259
|
* @see https://redis.io/commands/json.arrappend
|
|
2260
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrappend.mdx
|
|
2099
2261
|
*/
|
|
2100
2262
|
declare class JsonArrAppendCommand<TData extends unknown[]> extends Command<(null | string)[], (null | number)[]> {
|
|
2101
2263
|
constructor(cmd: [key: string, path: string, ...values: TData], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2103,6 +2265,7 @@ declare class JsonArrAppendCommand<TData extends unknown[]> extends Command<(nul
|
|
|
2103
2265
|
|
|
2104
2266
|
/**
|
|
2105
2267
|
* @see https://redis.io/commands/json.arrindex
|
|
2268
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrindex.mdx
|
|
2106
2269
|
*/
|
|
2107
2270
|
declare class JsonArrIndexCommand<TValue> extends Command<(null | string)[], (null | number)[]> {
|
|
2108
2271
|
constructor(cmd: [key: string, path: string, value: TValue, start?: number, stop?: number], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2110,6 +2273,7 @@ declare class JsonArrIndexCommand<TValue> extends Command<(null | string)[], (nu
|
|
|
2110
2273
|
|
|
2111
2274
|
/**
|
|
2112
2275
|
* @see https://redis.io/commands/json.arrinsert
|
|
2276
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrinsert.mdx
|
|
2113
2277
|
*/
|
|
2114
2278
|
declare class JsonArrInsertCommand<TData extends unknown[]> extends Command<(null | string)[], (null | number)[]> {
|
|
2115
2279
|
constructor(cmd: [key: string, path: string, index: number, ...values: TData], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2117,6 +2281,7 @@ declare class JsonArrInsertCommand<TData extends unknown[]> extends Command<(nul
|
|
|
2117
2281
|
|
|
2118
2282
|
/**
|
|
2119
2283
|
* @see https://redis.io/commands/json.arrlen
|
|
2284
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrlen.mdx
|
|
2120
2285
|
*/
|
|
2121
2286
|
declare class JsonArrLenCommand extends Command<(null | string)[], (null | number)[]> {
|
|
2122
2287
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2124,6 +2289,7 @@ declare class JsonArrLenCommand extends Command<(null | string)[], (null | numbe
|
|
|
2124
2289
|
|
|
2125
2290
|
/**
|
|
2126
2291
|
* @see https://redis.io/commands/json.arrpop
|
|
2292
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrpop.mdx
|
|
2127
2293
|
*/
|
|
2128
2294
|
declare class JsonArrPopCommand<TData> extends Command<(null | string)[], (TData | null)[]> {
|
|
2129
2295
|
constructor(cmd: [key: string, path?: string, index?: number], opts?: CommandOptions<(null | string)[], (TData | null)[]>);
|
|
@@ -2131,6 +2297,7 @@ declare class JsonArrPopCommand<TData> extends Command<(null | string)[], (TData
|
|
|
2131
2297
|
|
|
2132
2298
|
/**
|
|
2133
2299
|
* @see https://redis.io/commands/json.arrtrim
|
|
2300
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrtrim.mdx
|
|
2134
2301
|
*/
|
|
2135
2302
|
declare class JsonArrTrimCommand extends Command<(null | string)[], (null | number)[]> {
|
|
2136
2303
|
constructor(cmd: [key: string, path?: string, start?: number, stop?: number], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2138,6 +2305,7 @@ declare class JsonArrTrimCommand extends Command<(null | string)[], (null | numb
|
|
|
2138
2305
|
|
|
2139
2306
|
/**
|
|
2140
2307
|
* @see https://redis.io/commands/json.clear
|
|
2308
|
+
* @see node_modules/@upstash/redis/docs/commands/json/clear.mdx
|
|
2141
2309
|
*/
|
|
2142
2310
|
declare class JsonClearCommand extends Command<number, number> {
|
|
2143
2311
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<number, number>);
|
|
@@ -2145,6 +2313,7 @@ declare class JsonClearCommand extends Command<number, number> {
|
|
|
2145
2313
|
|
|
2146
2314
|
/**
|
|
2147
2315
|
* @see https://redis.io/commands/json.del
|
|
2316
|
+
* @see node_modules/@upstash/redis/docs/commands/json/del.mdx
|
|
2148
2317
|
*/
|
|
2149
2318
|
declare class JsonDelCommand extends Command<number, number> {
|
|
2150
2319
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<number, number>);
|
|
@@ -2152,6 +2321,7 @@ declare class JsonDelCommand extends Command<number, number> {
|
|
|
2152
2321
|
|
|
2153
2322
|
/**
|
|
2154
2323
|
* @see https://redis.io/commands/json.forget
|
|
2324
|
+
* @see node_modules/@upstash/redis/docs/commands/json/forget.mdx
|
|
2155
2325
|
*/
|
|
2156
2326
|
declare class JsonForgetCommand extends Command<number, number> {
|
|
2157
2327
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<number, number>);
|
|
@@ -2159,6 +2329,7 @@ declare class JsonForgetCommand extends Command<number, number> {
|
|
|
2159
2329
|
|
|
2160
2330
|
/**
|
|
2161
2331
|
* @see https://redis.io/commands/json.get
|
|
2332
|
+
* @see node_modules/@upstash/redis/docs/commands/json/get.mdx
|
|
2162
2333
|
*/
|
|
2163
2334
|
declare class JsonGetCommand<TData extends (unknown | Record<string, unknown>) | (unknown | Record<string, unknown>)[]> extends Command<TData | null, TData | null> {
|
|
2164
2335
|
constructor(cmd: [
|
|
@@ -2174,6 +2345,7 @@ declare class JsonGetCommand<TData extends (unknown | Record<string, unknown>) |
|
|
|
2174
2345
|
|
|
2175
2346
|
/**
|
|
2176
2347
|
* @see https://redis.io/commands/json.merge
|
|
2348
|
+
* @see node_modules/@upstash/redis/docs/commands/json/merge.mdx
|
|
2177
2349
|
*/
|
|
2178
2350
|
declare class JsonMergeCommand<TData extends string | number | Record<string, unknown> | Array<unknown>> extends Command<"OK" | null, "OK" | null> {
|
|
2179
2351
|
constructor(cmd: [key: string, path: string, value: TData], opts?: CommandOptions<"OK" | null, "OK" | null>);
|
|
@@ -2181,6 +2353,7 @@ declare class JsonMergeCommand<TData extends string | number | Record<string, un
|
|
|
2181
2353
|
|
|
2182
2354
|
/**
|
|
2183
2355
|
* @see https://redis.io/commands/json.mget
|
|
2356
|
+
* @see node_modules/@upstash/redis/docs/commands/json/mget.mdx
|
|
2184
2357
|
*/
|
|
2185
2358
|
declare class JsonMGetCommand<TData = unknown[]> extends Command<TData, TData> {
|
|
2186
2359
|
constructor(cmd: [keys: string[], path: string], opts?: CommandOptions<TData, TData>);
|
|
@@ -2188,6 +2361,7 @@ declare class JsonMGetCommand<TData = unknown[]> extends Command<TData, TData> {
|
|
|
2188
2361
|
|
|
2189
2362
|
/**
|
|
2190
2363
|
* @see https://redis.io/commands/json.mset
|
|
2364
|
+
* @see node_modules/@upstash/redis/docs/commands/json/mset.mdx
|
|
2191
2365
|
*/
|
|
2192
2366
|
declare class JsonMSetCommand<TData extends number | string | boolean | Record<string, unknown> | (number | string | boolean | Record<string, unknown>)[]> extends Command<"OK" | null, "OK" | null> {
|
|
2193
2367
|
constructor(cmd: {
|
|
@@ -2199,6 +2373,7 @@ declare class JsonMSetCommand<TData extends number | string | boolean | Record<s
|
|
|
2199
2373
|
|
|
2200
2374
|
/**
|
|
2201
2375
|
* @see https://redis.io/commands/json.numincrby
|
|
2376
|
+
* @see node_modules/@upstash/redis/docs/commands/json/numincrby.mdx
|
|
2202
2377
|
*/
|
|
2203
2378
|
declare class JsonNumIncrByCommand extends Command<(null | string)[], (null | number)[]> {
|
|
2204
2379
|
constructor(cmd: [key: string, path: string, value: number], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2206,6 +2381,7 @@ declare class JsonNumIncrByCommand extends Command<(null | string)[], (null | nu
|
|
|
2206
2381
|
|
|
2207
2382
|
/**
|
|
2208
2383
|
* @see https://redis.io/commands/json.nummultby
|
|
2384
|
+
* @see node_modules/@upstash/redis/docs/commands/json/nummultby.mdx
|
|
2209
2385
|
*/
|
|
2210
2386
|
declare class JsonNumMultByCommand extends Command<(null | string)[], (null | number)[]> {
|
|
2211
2387
|
constructor(cmd: [key: string, path: string, value: number], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2213,6 +2389,7 @@ declare class JsonNumMultByCommand extends Command<(null | string)[], (null | nu
|
|
|
2213
2389
|
|
|
2214
2390
|
/**
|
|
2215
2391
|
* @see https://redis.io/commands/json.objkeys
|
|
2392
|
+
* @see node_modules/@upstash/redis/docs/commands/json/objkeys.mdx
|
|
2216
2393
|
*/
|
|
2217
2394
|
declare class JsonObjKeysCommand extends Command<(string[] | null)[], (string[] | null)[]> {
|
|
2218
2395
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<(string[] | null)[], (string[] | null)[]>);
|
|
@@ -2220,6 +2397,7 @@ declare class JsonObjKeysCommand extends Command<(string[] | null)[], (string[]
|
|
|
2220
2397
|
|
|
2221
2398
|
/**
|
|
2222
2399
|
* @see https://redis.io/commands/json.objlen
|
|
2400
|
+
* @see node_modules/@upstash/redis/docs/commands/json/objlen.mdx
|
|
2223
2401
|
*/
|
|
2224
2402
|
declare class JsonObjLenCommand extends Command<(number | null)[], (number | null)[]> {
|
|
2225
2403
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<(number | null)[], (number | null)[]>);
|
|
@@ -2234,6 +2412,7 @@ declare class JsonRespCommand<TData extends unknown[]> extends Command<TData, TD
|
|
|
2234
2412
|
|
|
2235
2413
|
/**
|
|
2236
2414
|
* @see https://redis.io/commands/json.set
|
|
2415
|
+
* @see node_modules/@upstash/redis/docs/commands/json/set.mdx
|
|
2237
2416
|
*/
|
|
2238
2417
|
declare class JsonSetCommand<TData extends number | string | boolean | Record<string, unknown> | (number | string | boolean | Record<string, unknown>)[]> extends Command<"OK" | null, "OK" | null> {
|
|
2239
2418
|
constructor(cmd: [
|
|
@@ -2252,6 +2431,7 @@ declare class JsonSetCommand<TData extends number | string | boolean | Record<st
|
|
|
2252
2431
|
|
|
2253
2432
|
/**
|
|
2254
2433
|
* @see https://redis.io/commands/json.strappend
|
|
2434
|
+
* @see node_modules/@upstash/redis/docs/commands/json/strappend.mdx
|
|
2255
2435
|
*/
|
|
2256
2436
|
declare class JsonStrAppendCommand extends Command<(null | string)[], (null | number)[]> {
|
|
2257
2437
|
constructor(cmd: [key: string, path: string, value: string], opts?: CommandOptions<(null | string)[], (null | number)[]>);
|
|
@@ -2259,6 +2439,7 @@ declare class JsonStrAppendCommand extends Command<(null | string)[], (null | nu
|
|
|
2259
2439
|
|
|
2260
2440
|
/**
|
|
2261
2441
|
* @see https://redis.io/commands/json.strlen
|
|
2442
|
+
* @see node_modules/@upstash/redis/docs/commands/json/strlen.mdx
|
|
2262
2443
|
*/
|
|
2263
2444
|
declare class JsonStrLenCommand extends Command<(number | null)[], (number | null)[]> {
|
|
2264
2445
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<(number | null)[], (number | null)[]>);
|
|
@@ -2266,6 +2447,7 @@ declare class JsonStrLenCommand extends Command<(number | null)[], (number | nul
|
|
|
2266
2447
|
|
|
2267
2448
|
/**
|
|
2268
2449
|
* @see https://redis.io/commands/json.toggle
|
|
2450
|
+
* @see node_modules/@upstash/redis/docs/commands/json/toggle.mdx
|
|
2269
2451
|
*/
|
|
2270
2452
|
declare class JsonToggleCommand extends Command<number[], number[]> {
|
|
2271
2453
|
constructor(cmd: [key: string, path: string], opts?: CommandOptions<number[], number[]>);
|
|
@@ -2273,6 +2455,7 @@ declare class JsonToggleCommand extends Command<number[], number[]> {
|
|
|
2273
2455
|
|
|
2274
2456
|
/**
|
|
2275
2457
|
* @see https://redis.io/commands/json.type
|
|
2458
|
+
* @see node_modules/@upstash/redis/docs/commands/json/type.mdx
|
|
2276
2459
|
*/
|
|
2277
2460
|
declare class JsonTypeCommand extends Command<string[], string[]> {
|
|
2278
2461
|
constructor(cmd: [key: string, path?: string], opts?: CommandOptions<string[], string[]>);
|
|
@@ -2280,6 +2463,7 @@ declare class JsonTypeCommand extends Command<string[], string[]> {
|
|
|
2280
2463
|
|
|
2281
2464
|
/**
|
|
2282
2465
|
* @see https://redis.io/commands/keys
|
|
2466
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/keys.mdx
|
|
2283
2467
|
*/
|
|
2284
2468
|
declare class KeysCommand extends Command<string[], string[]> {
|
|
2285
2469
|
constructor(cmd: [pattern: string], opts?: CommandOptions<string[], string[]>);
|
|
@@ -2295,6 +2479,7 @@ declare class LInsertCommand<TData = string> extends Command<number, number> {
|
|
|
2295
2479
|
|
|
2296
2480
|
/**
|
|
2297
2481
|
* @see https://redis.io/commands/llen
|
|
2482
|
+
* @see node_modules/@upstash/redis/docs/commands/list/llen.mdx
|
|
2298
2483
|
*/
|
|
2299
2484
|
declare class LLenCommand extends Command<number, number> {
|
|
2300
2485
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -2302,6 +2487,7 @@ declare class LLenCommand extends Command<number, number> {
|
|
|
2302
2487
|
|
|
2303
2488
|
/**
|
|
2304
2489
|
* @see https://redis.io/commands/lmove
|
|
2490
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lmove.mdx
|
|
2305
2491
|
*/
|
|
2306
2492
|
declare class LMoveCommand<TData = string> extends Command<TData, TData> {
|
|
2307
2493
|
constructor(cmd: [
|
|
@@ -2327,6 +2513,10 @@ declare class LmPopCommand<TValues> extends Command<[
|
|
|
2327
2513
|
|
|
2328
2514
|
/**
|
|
2329
2515
|
* @see https://redis.io/commands/lpop
|
|
2516
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpop.mdx
|
|
2517
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
2518
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
2519
|
+
* to receive raw strings.
|
|
2330
2520
|
*/
|
|
2331
2521
|
declare class LPopCommand<TData = string> extends Command<unknown | null, TData | null> {
|
|
2332
2522
|
constructor(cmd: [key: string, count?: number], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -2334,6 +2524,7 @@ declare class LPopCommand<TData = string> extends Command<unknown | null, TData
|
|
|
2334
2524
|
|
|
2335
2525
|
/**
|
|
2336
2526
|
* @see https://redis.io/commands/lpos
|
|
2527
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpos.mdx
|
|
2337
2528
|
*/
|
|
2338
2529
|
declare class LPosCommand<TData = number> extends Command<TData, TData> {
|
|
2339
2530
|
constructor(cmd: [key: string, element: unknown, opts?: {
|
|
@@ -2345,6 +2536,7 @@ declare class LPosCommand<TData = number> extends Command<TData, TData> {
|
|
|
2345
2536
|
|
|
2346
2537
|
/**
|
|
2347
2538
|
* @see https://redis.io/commands/lpush
|
|
2539
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpush.mdx
|
|
2348
2540
|
*/
|
|
2349
2541
|
declare class LPushCommand<TData = string> extends Command<number, number> {
|
|
2350
2542
|
constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -2352,6 +2544,7 @@ declare class LPushCommand<TData = string> extends Command<number, number> {
|
|
|
2352
2544
|
|
|
2353
2545
|
/**
|
|
2354
2546
|
* @see https://redis.io/commands/lpushx
|
|
2547
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpushx.mdx
|
|
2355
2548
|
*/
|
|
2356
2549
|
declare class LPushXCommand<TData> extends Command<number, number> {
|
|
2357
2550
|
constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -2375,6 +2568,10 @@ declare class LTrimCommand extends Command<"OK", "OK"> {
|
|
|
2375
2568
|
|
|
2376
2569
|
/**
|
|
2377
2570
|
* @see https://redis.io/commands/mget
|
|
2571
|
+
* @see node_modules/@upstash/redis/docs/commands/string/mget.mdx
|
|
2572
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
2573
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
2574
|
+
* to receive raw strings.
|
|
2378
2575
|
*/
|
|
2379
2576
|
declare class MGetCommand<TData extends unknown[]> extends Command<(string | null)[], TData> {
|
|
2380
2577
|
constructor(cmd: [string[]] | [...string[]], opts?: CommandOptions<(string | null)[], TData>);
|
|
@@ -2382,6 +2579,7 @@ declare class MGetCommand<TData extends unknown[]> extends Command<(string | nul
|
|
|
2382
2579
|
|
|
2383
2580
|
/**
|
|
2384
2581
|
* @see https://redis.io/commands/mset
|
|
2582
|
+
* @see node_modules/@upstash/redis/docs/commands/string/mset.mdx
|
|
2385
2583
|
*/
|
|
2386
2584
|
declare class MSetCommand<TData> extends Command<"OK", "OK"> {
|
|
2387
2585
|
constructor([kv]: [kv: Record<string, TData>], opts?: CommandOptions<"OK", "OK">);
|
|
@@ -2389,6 +2587,7 @@ declare class MSetCommand<TData> extends Command<"OK", "OK"> {
|
|
|
2389
2587
|
|
|
2390
2588
|
/**
|
|
2391
2589
|
* @see https://redis.io/commands/msetnx
|
|
2590
|
+
* @see node_modules/@upstash/redis/docs/commands/string/msetnx.mdx
|
|
2392
2591
|
*/
|
|
2393
2592
|
declare class MSetNXCommand<TData = string> extends Command<number, number> {
|
|
2394
2593
|
constructor([kv]: [kv: Record<string, TData>], opts?: CommandOptions<number, number>);
|
|
@@ -2396,6 +2595,7 @@ declare class MSetNXCommand<TData = string> extends Command<number, number> {
|
|
|
2396
2595
|
|
|
2397
2596
|
/**
|
|
2398
2597
|
* @see https://redis.io/commands/persist
|
|
2598
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/persist.mdx
|
|
2399
2599
|
*/
|
|
2400
2600
|
declare class PersistCommand extends Command<"0" | "1", 0 | 1> {
|
|
2401
2601
|
constructor(cmd: [key: string], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2403,6 +2603,7 @@ declare class PersistCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
2403
2603
|
|
|
2404
2604
|
/**
|
|
2405
2605
|
* @see https://redis.io/commands/pexpire
|
|
2606
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pexpire.mdx
|
|
2406
2607
|
*/
|
|
2407
2608
|
declare class PExpireCommand extends Command<"0" | "1", 0 | 1> {
|
|
2408
2609
|
constructor(cmd: [key: string, milliseconds: number, option?: ExpireOption], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2410,6 +2611,7 @@ declare class PExpireCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
2410
2611
|
|
|
2411
2612
|
/**
|
|
2412
2613
|
* @see https://redis.io/commands/pexpireat
|
|
2614
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pexpireat.mdx
|
|
2413
2615
|
*/
|
|
2414
2616
|
declare class PExpireAtCommand extends Command<"0" | "1", 0 | 1> {
|
|
2415
2617
|
constructor(cmd: [key: string, unix: number, option?: ExpireOption], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2438,6 +2640,7 @@ declare class PfMergeCommand extends Command<"OK", "OK"> {
|
|
|
2438
2640
|
|
|
2439
2641
|
/**
|
|
2440
2642
|
* @see https://redis.io/commands/ping
|
|
2643
|
+
* @see node_modules/@upstash/redis/docs/commands/auth/ping.mdx
|
|
2441
2644
|
*/
|
|
2442
2645
|
declare class PingCommand extends Command<string | "PONG", string | "PONG"> {
|
|
2443
2646
|
constructor(cmd?: [message?: string], opts?: CommandOptions<string | "PONG", string | "PONG">);
|
|
@@ -2452,6 +2655,7 @@ declare class PSetEXCommand<TData = string> extends Command<string, string> {
|
|
|
2452
2655
|
|
|
2453
2656
|
/**
|
|
2454
2657
|
* @see https://redis.io/commands/pttl
|
|
2658
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pttl.mdx
|
|
2455
2659
|
*/
|
|
2456
2660
|
declare class PTtlCommand extends Command<number, number> {
|
|
2457
2661
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -2459,6 +2663,7 @@ declare class PTtlCommand extends Command<number, number> {
|
|
|
2459
2663
|
|
|
2460
2664
|
/**
|
|
2461
2665
|
* @see https://redis.io/commands/publish
|
|
2666
|
+
* @see node_modules/@upstash/redis/docs/commands/pubsub/publish.mdx
|
|
2462
2667
|
*/
|
|
2463
2668
|
declare class PublishCommand<TMessage = unknown> extends Command<number, number> {
|
|
2464
2669
|
constructor(cmd: [channel: string, message: TMessage], opts?: CommandOptions<number, number>);
|
|
@@ -2466,6 +2671,7 @@ declare class PublishCommand<TMessage = unknown> extends Command<number, number>
|
|
|
2466
2671
|
|
|
2467
2672
|
/**
|
|
2468
2673
|
* @see https://redis.io/commands/randomkey
|
|
2674
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/randomkey.mdx
|
|
2469
2675
|
*/
|
|
2470
2676
|
declare class RandomKeyCommand extends Command<string | null, string | null> {
|
|
2471
2677
|
constructor(opts?: CommandOptions<string | null, string | null>);
|
|
@@ -2473,6 +2679,7 @@ declare class RandomKeyCommand extends Command<string | null, string | null> {
|
|
|
2473
2679
|
|
|
2474
2680
|
/**
|
|
2475
2681
|
* @see https://redis.io/commands/rename
|
|
2682
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/rename.mdx
|
|
2476
2683
|
*/
|
|
2477
2684
|
declare class RenameCommand extends Command<"OK", "OK"> {
|
|
2478
2685
|
constructor(cmd: [source: string, destination: string], opts?: CommandOptions<"OK", "OK">);
|
|
@@ -2480,6 +2687,7 @@ declare class RenameCommand extends Command<"OK", "OK"> {
|
|
|
2480
2687
|
|
|
2481
2688
|
/**
|
|
2482
2689
|
* @see https://redis.io/commands/renamenx
|
|
2690
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/renamenx.mdx
|
|
2483
2691
|
*/
|
|
2484
2692
|
declare class RenameNXCommand extends Command<"0" | "1", 0 | 1> {
|
|
2485
2693
|
constructor(cmd: [source: string, destination: string], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2487,6 +2695,10 @@ declare class RenameNXCommand extends Command<"0" | "1", 0 | 1> {
|
|
|
2487
2695
|
|
|
2488
2696
|
/**
|
|
2489
2697
|
* @see https://redis.io/commands/rpop
|
|
2698
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpop.mdx
|
|
2699
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
2700
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
2701
|
+
* to receive raw strings.
|
|
2490
2702
|
*/
|
|
2491
2703
|
declare class RPopCommand<TData extends unknown | unknown[] = string> extends Command<unknown | null, TData | null> {
|
|
2492
2704
|
constructor(cmd: [key: string, count?: number], opts?: CommandOptions<unknown | null, TData | null>);
|
|
@@ -2494,6 +2706,7 @@ declare class RPopCommand<TData extends unknown | unknown[] = string> extends Co
|
|
|
2494
2706
|
|
|
2495
2707
|
/**
|
|
2496
2708
|
* @see https://redis.io/commands/rpush
|
|
2709
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpush.mdx
|
|
2497
2710
|
*/
|
|
2498
2711
|
declare class RPushCommand<TData = string> extends Command<number, number> {
|
|
2499
2712
|
constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -2501,6 +2714,7 @@ declare class RPushCommand<TData = string> extends Command<number, number> {
|
|
|
2501
2714
|
|
|
2502
2715
|
/**
|
|
2503
2716
|
* @see https://redis.io/commands/rpushx
|
|
2717
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpushx.mdx
|
|
2504
2718
|
*/
|
|
2505
2719
|
declare class RPushXCommand<TData = string> extends Command<number, number> {
|
|
2506
2720
|
constructor(cmd: [key: string, ...elements: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -2508,6 +2722,7 @@ declare class RPushXCommand<TData = string> extends Command<number, number> {
|
|
|
2508
2722
|
|
|
2509
2723
|
/**
|
|
2510
2724
|
* @see https://redis.io/commands/sadd
|
|
2725
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sadd.mdx
|
|
2511
2726
|
*/
|
|
2512
2727
|
declare class SAddCommand<TData = string> extends Command<number, number> {
|
|
2513
2728
|
constructor(cmd: [key: string, member: TData, ...members: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -2515,6 +2730,7 @@ declare class SAddCommand<TData = string> extends Command<number, number> {
|
|
|
2515
2730
|
|
|
2516
2731
|
/**
|
|
2517
2732
|
* @see https://redis.io/commands/scard
|
|
2733
|
+
* @see node_modules/@upstash/redis/docs/commands/set/scard.mdx
|
|
2518
2734
|
*/
|
|
2519
2735
|
declare class SCardCommand extends Command<number, number> {
|
|
2520
2736
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -2522,6 +2738,7 @@ declare class SCardCommand extends Command<number, number> {
|
|
|
2522
2738
|
|
|
2523
2739
|
/**
|
|
2524
2740
|
* @see https://redis.io/commands/script-exists
|
|
2741
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_exists.mdx
|
|
2525
2742
|
*/
|
|
2526
2743
|
declare class ScriptExistsCommand<T extends string[]> extends Command<string[], number[]> {
|
|
2527
2744
|
constructor(hashes: T, opts?: CommandOptions<string[], number[]>);
|
|
@@ -2536,6 +2753,7 @@ type ScriptFlushCommandOptions = {
|
|
|
2536
2753
|
};
|
|
2537
2754
|
/**
|
|
2538
2755
|
* @see https://redis.io/commands/script-flush
|
|
2756
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_flush.mdx
|
|
2539
2757
|
*/
|
|
2540
2758
|
declare class ScriptFlushCommand extends Command<"OK", "OK"> {
|
|
2541
2759
|
constructor([opts]: [opts?: ScriptFlushCommandOptions], cmdOpts?: CommandOptions<"OK", "OK">);
|
|
@@ -2543,6 +2761,7 @@ declare class ScriptFlushCommand extends Command<"OK", "OK"> {
|
|
|
2543
2761
|
|
|
2544
2762
|
/**
|
|
2545
2763
|
* @see https://redis.io/commands/script-load
|
|
2764
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_load.mdx
|
|
2546
2765
|
*/
|
|
2547
2766
|
declare class ScriptLoadCommand extends Command<string, string> {
|
|
2548
2767
|
constructor(args: [script: string], opts?: CommandOptions<string, string>);
|
|
@@ -2550,6 +2769,7 @@ declare class ScriptLoadCommand extends Command<string, string> {
|
|
|
2550
2769
|
|
|
2551
2770
|
/**
|
|
2552
2771
|
* @see https://redis.io/commands/sdiff
|
|
2772
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sdiff.mdx
|
|
2553
2773
|
*/
|
|
2554
2774
|
declare class SDiffCommand<TData> extends Command<unknown[], TData[]> {
|
|
2555
2775
|
constructor(cmd: [key: string, ...keys: string[]], opts?: CommandOptions<unknown[], TData[]>);
|
|
@@ -2557,6 +2777,7 @@ declare class SDiffCommand<TData> extends Command<unknown[], TData[]> {
|
|
|
2557
2777
|
|
|
2558
2778
|
/**
|
|
2559
2779
|
* @see https://redis.io/commands/sdiffstore
|
|
2780
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sdiffstore.mdx
|
|
2560
2781
|
*/
|
|
2561
2782
|
declare class SDiffStoreCommand extends Command<number, number> {
|
|
2562
2783
|
constructor(cmd: [destination: string, ...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -2612,6 +2833,7 @@ type SetCommandOptions = {
|
|
|
2612
2833
|
});
|
|
2613
2834
|
/**
|
|
2614
2835
|
* @see https://redis.io/commands/set
|
|
2836
|
+
* @see node_modules/@upstash/redis/docs/commands/string/set.mdx
|
|
2615
2837
|
*/
|
|
2616
2838
|
declare class SetCommand<TData, TResult = TData | "OK" | null> extends Command<TResult, TData | "OK" | null> {
|
|
2617
2839
|
constructor([key, value, opts]: [key: string, value: TData, opts?: SetCommandOptions], cmdOpts?: CommandOptions<TResult, TData>);
|
|
@@ -2619,6 +2841,7 @@ declare class SetCommand<TData, TResult = TData | "OK" | null> extends Command<T
|
|
|
2619
2841
|
|
|
2620
2842
|
/**
|
|
2621
2843
|
* @see https://redis.io/commands/setbit
|
|
2844
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/setbit.mdx
|
|
2622
2845
|
*/
|
|
2623
2846
|
declare class SetBitCommand extends Command<"0" | "1", 0 | 1> {
|
|
2624
2847
|
constructor(cmd: [key: string, offset: number, value: 0 | 1], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2640,6 +2863,7 @@ declare class SetNxCommand<TData = string> extends Command<number, number> {
|
|
|
2640
2863
|
|
|
2641
2864
|
/**
|
|
2642
2865
|
* @see https://redis.io/commands/setrange
|
|
2866
|
+
* @see node_modules/@upstash/redis/docs/commands/string/setrange.mdx
|
|
2643
2867
|
*/
|
|
2644
2868
|
declare class SetRangeCommand extends Command<number, number> {
|
|
2645
2869
|
constructor(cmd: [key: string, offset: number, value: string], opts?: CommandOptions<number, number>);
|
|
@@ -2647,6 +2871,7 @@ declare class SetRangeCommand extends Command<number, number> {
|
|
|
2647
2871
|
|
|
2648
2872
|
/**
|
|
2649
2873
|
* @see https://redis.io/commands/sinter
|
|
2874
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sinter.mdx
|
|
2650
2875
|
*/
|
|
2651
2876
|
declare class SInterCommand<TData = string> extends Command<unknown[], TData[]> {
|
|
2652
2877
|
constructor(cmd: [key: string, ...keys: string[]], opts?: CommandOptions<unknown[], TData[]>);
|
|
@@ -2663,6 +2888,7 @@ declare class SInterCardCommand extends Command<number, number> {
|
|
|
2663
2888
|
|
|
2664
2889
|
/**
|
|
2665
2890
|
* @see https://redis.io/commands/sinterstore
|
|
2891
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sinterstore.mdx
|
|
2666
2892
|
*/
|
|
2667
2893
|
declare class SInterStoreCommand extends Command<number, number> {
|
|
2668
2894
|
constructor(cmd: [destination: string, key: string, ...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -2670,6 +2896,7 @@ declare class SInterStoreCommand extends Command<number, number> {
|
|
|
2670
2896
|
|
|
2671
2897
|
/**
|
|
2672
2898
|
* @see https://redis.io/commands/sismember
|
|
2899
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sismember.mdx
|
|
2673
2900
|
*/
|
|
2674
2901
|
declare class SIsMemberCommand<TData = string> extends Command<"0" | "1", 0 | 1> {
|
|
2675
2902
|
constructor(cmd: [key: string, member: TData], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2677,6 +2904,7 @@ declare class SIsMemberCommand<TData = string> extends Command<"0" | "1", 0 | 1>
|
|
|
2677
2904
|
|
|
2678
2905
|
/**
|
|
2679
2906
|
* @see https://redis.io/commands/smembers
|
|
2907
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smembers.mdx
|
|
2680
2908
|
*/
|
|
2681
2909
|
declare class SMembersCommand<TData extends unknown[] = string[]> extends Command<unknown[], TData> {
|
|
2682
2910
|
constructor(cmd: [key: string], opts?: CommandOptions<unknown[], TData>);
|
|
@@ -2684,6 +2912,7 @@ declare class SMembersCommand<TData extends unknown[] = string[]> extends Comman
|
|
|
2684
2912
|
|
|
2685
2913
|
/**
|
|
2686
2914
|
* @see https://redis.io/commands/smismember
|
|
2915
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smismember.mdx
|
|
2687
2916
|
*/
|
|
2688
2917
|
declare class SMIsMemberCommand<TMembers extends unknown[]> extends Command<("0" | "1")[], (0 | 1)[]> {
|
|
2689
2918
|
constructor(cmd: [key: string, members: TMembers], opts?: CommandOptions<("0" | "1")[], (0 | 1)[]>);
|
|
@@ -2691,6 +2920,7 @@ declare class SMIsMemberCommand<TMembers extends unknown[]> extends Command<("0"
|
|
|
2691
2920
|
|
|
2692
2921
|
/**
|
|
2693
2922
|
* @see https://redis.io/commands/smove
|
|
2923
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smove.mdx
|
|
2694
2924
|
*/
|
|
2695
2925
|
declare class SMoveCommand<TData> extends Command<"0" | "1", 0 | 1> {
|
|
2696
2926
|
constructor(cmd: [source: string, destination: string, member: TData], opts?: CommandOptions<"0" | "1", 0 | 1>);
|
|
@@ -2698,6 +2928,7 @@ declare class SMoveCommand<TData> extends Command<"0" | "1", 0 | 1> {
|
|
|
2698
2928
|
|
|
2699
2929
|
/**
|
|
2700
2930
|
* @see https://redis.io/commands/spop
|
|
2931
|
+
* @see node_modules/@upstash/redis/docs/commands/set/spop.mdx
|
|
2701
2932
|
*/
|
|
2702
2933
|
declare class SPopCommand<TData> extends Command<string | string[] | null, TData | null> {
|
|
2703
2934
|
constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string | string[] | null, TData | null>);
|
|
@@ -2705,6 +2936,7 @@ declare class SPopCommand<TData> extends Command<string | string[] | null, TData
|
|
|
2705
2936
|
|
|
2706
2937
|
/**
|
|
2707
2938
|
* @see https://redis.io/commands/srandmember
|
|
2939
|
+
* @see node_modules/@upstash/redis/docs/commands/set/srandmember.mdx
|
|
2708
2940
|
*/
|
|
2709
2941
|
declare class SRandMemberCommand<TData> extends Command<string | null, TData | null> {
|
|
2710
2942
|
constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string | null, TData | null>);
|
|
@@ -2712,6 +2944,7 @@ declare class SRandMemberCommand<TData> extends Command<string | null, TData | n
|
|
|
2712
2944
|
|
|
2713
2945
|
/**
|
|
2714
2946
|
* @see https://redis.io/commands/srem
|
|
2947
|
+
* @see node_modules/@upstash/redis/docs/commands/set/srem.mdx
|
|
2715
2948
|
*/
|
|
2716
2949
|
declare class SRemCommand<TData = string> extends Command<number, number> {
|
|
2717
2950
|
constructor(cmd: [key: string, ...members: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -2719,6 +2952,7 @@ declare class SRemCommand<TData = string> extends Command<number, number> {
|
|
|
2719
2952
|
|
|
2720
2953
|
/**
|
|
2721
2954
|
* @see https://redis.io/commands/sscan
|
|
2955
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sscan.mdx
|
|
2722
2956
|
*/
|
|
2723
2957
|
declare class SScanCommand extends Command<[
|
|
2724
2958
|
string,
|
|
@@ -2732,6 +2966,7 @@ declare class SScanCommand extends Command<[
|
|
|
2732
2966
|
|
|
2733
2967
|
/**
|
|
2734
2968
|
* @see https://redis.io/commands/strlen
|
|
2969
|
+
* @see node_modules/@upstash/redis/docs/commands/string/strlen.mdx
|
|
2735
2970
|
*/
|
|
2736
2971
|
declare class StrLenCommand extends Command<number, number> {
|
|
2737
2972
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -2739,6 +2974,7 @@ declare class StrLenCommand extends Command<number, number> {
|
|
|
2739
2974
|
|
|
2740
2975
|
/**
|
|
2741
2976
|
* @see https://redis.io/commands/sunion
|
|
2977
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sunion.mdx
|
|
2742
2978
|
*/
|
|
2743
2979
|
declare class SUnionCommand<TData> extends Command<string[], TData[]> {
|
|
2744
2980
|
constructor(cmd: [key: string, ...keys: string[]], opts?: CommandOptions<string[], TData[]>);
|
|
@@ -2746,6 +2982,7 @@ declare class SUnionCommand<TData> extends Command<string[], TData[]> {
|
|
|
2746
2982
|
|
|
2747
2983
|
/**
|
|
2748
2984
|
* @see https://redis.io/commands/sunionstore
|
|
2985
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sunionstore.mdx
|
|
2749
2986
|
*/
|
|
2750
2987
|
declare class SUnionStoreCommand extends Command<number, number> {
|
|
2751
2988
|
constructor(cmd: [destination: string, key: string, ...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -2760,6 +2997,7 @@ declare class TimeCommand extends Command<[number, number], [number, number]> {
|
|
|
2760
2997
|
|
|
2761
2998
|
/**
|
|
2762
2999
|
* @see https://redis.io/commands/touch
|
|
3000
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/touch.mdx
|
|
2763
3001
|
*/
|
|
2764
3002
|
declare class TouchCommand extends Command<number, number> {
|
|
2765
3003
|
constructor(cmd: [...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -2767,6 +3005,7 @@ declare class TouchCommand extends Command<number, number> {
|
|
|
2767
3005
|
|
|
2768
3006
|
/**
|
|
2769
3007
|
* @see https://redis.io/commands/ttl
|
|
3008
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/ttl.mdx
|
|
2770
3009
|
*/
|
|
2771
3010
|
declare class TtlCommand extends Command<number, number> {
|
|
2772
3011
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -2774,6 +3013,7 @@ declare class TtlCommand extends Command<number, number> {
|
|
|
2774
3013
|
|
|
2775
3014
|
/**
|
|
2776
3015
|
* @see https://redis.io/commands/unlink
|
|
3016
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/unlink.mdx
|
|
2777
3017
|
*/
|
|
2778
3018
|
declare class UnlinkCommand extends Command<number, number> {
|
|
2779
3019
|
constructor(cmd: [...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -2845,6 +3085,7 @@ declare class VectorQueryCommand extends Command<[string, string | number][], Ve
|
|
|
2845
3085
|
|
|
2846
3086
|
/**
|
|
2847
3087
|
* @see https://redis.io/commands/xack
|
|
3088
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xack.mdx
|
|
2848
3089
|
*/
|
|
2849
3090
|
declare class XAckCommand extends Command<number, number> {
|
|
2850
3091
|
constructor([key, group, id]: [key: string, group: string, id: string | string[]], opts?: CommandOptions<number, number>);
|
|
@@ -2853,6 +3094,7 @@ declare class XAckCommand extends Command<number, number> {
|
|
|
2853
3094
|
type XAckDelOption = "KEEPREF" | "keepref" | "DELREF" | "delref" | "ACKED" | "acked";
|
|
2854
3095
|
/**
|
|
2855
3096
|
* @see https://redis.io/commands/xackdel
|
|
3097
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xackdel.mdx
|
|
2856
3098
|
*/
|
|
2857
3099
|
declare class XAckDelCommand extends Command<number[], number[]> {
|
|
2858
3100
|
constructor([key, group, opts, ...ids]: [key: string, group: string, opts: XAckDelOption, ...ids: string[]], cmdOpts?: CommandOptions<number[], number[]>);
|
|
@@ -2876,6 +3118,7 @@ type XAddCommandOptions = {
|
|
|
2876
3118
|
};
|
|
2877
3119
|
/**
|
|
2878
3120
|
* @see https://redis.io/commands/xadd
|
|
3121
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xadd.mdx
|
|
2879
3122
|
*
|
|
2880
3123
|
* Stream ID formats:
|
|
2881
3124
|
* - "*" - Fully automatic ID generation
|
|
@@ -2893,6 +3136,7 @@ declare class XAddCommand extends Command<string, string> {
|
|
|
2893
3136
|
|
|
2894
3137
|
/**
|
|
2895
3138
|
* @see https://redis.io/commands/xautoclaim
|
|
3139
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xautoclaim.mdx
|
|
2896
3140
|
*/
|
|
2897
3141
|
declare class XAutoClaim extends Command<unknown[], unknown[]> {
|
|
2898
3142
|
constructor([key, group, consumer, minIdleTime, start, options]: [
|
|
@@ -2910,6 +3154,7 @@ declare class XAutoClaim extends Command<unknown[], unknown[]> {
|
|
|
2910
3154
|
|
|
2911
3155
|
/**
|
|
2912
3156
|
* @see https://redis.io/commands/xclaim
|
|
3157
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xclaim.mdx
|
|
2913
3158
|
*/
|
|
2914
3159
|
declare class XClaimCommand extends Command<unknown[], unknown[]> {
|
|
2915
3160
|
constructor([key, group, consumer, minIdleTime, id, options]: [
|
|
@@ -2931,6 +3176,7 @@ declare class XClaimCommand extends Command<unknown[], unknown[]> {
|
|
|
2931
3176
|
|
|
2932
3177
|
/**
|
|
2933
3178
|
* @see https://redis.io/commands/xdel
|
|
3179
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xdel.mdx
|
|
2934
3180
|
*/
|
|
2935
3181
|
declare class XDelCommand extends Command<number, number> {
|
|
2936
3182
|
constructor([key, ids]: [key: string, ids: string[] | string], opts?: CommandOptions<number, number>);
|
|
@@ -2939,6 +3185,7 @@ declare class XDelCommand extends Command<number, number> {
|
|
|
2939
3185
|
type XDelExOption = "KEEPREF" | "keepref" | "DELREF" | "delref" | "ACKED" | "acked";
|
|
2940
3186
|
/**
|
|
2941
3187
|
* @see https://redis.io/commands/xdelex
|
|
3188
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xdelex.mdx
|
|
2942
3189
|
*/
|
|
2943
3190
|
declare class XDelExCommand extends Command<number[], number[]> {
|
|
2944
3191
|
constructor([key, opts, ...ids]: [key: string, opts?: XDelExOption, ...ids: string[]], cmdOpts?: CommandOptions<number[], number[]>);
|
|
@@ -2974,6 +3221,7 @@ type XGroupCommandType = {
|
|
|
2974
3221
|
type XGroupReturnType<T extends XGroupCommandType> = T["type"] extends "CREATE" ? string : T["type"] extends "CREATECONSUMER" ? 0 | 1 : T["type"] extends "DELCONSUMER" ? number : T["type"] extends "DESTROY" ? 0 | 1 : T["type"] extends "SETID" ? string : never;
|
|
2975
3222
|
/**
|
|
2976
3223
|
* @see https://redis.io/commands/xgroup
|
|
3224
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xgroup.mdx
|
|
2977
3225
|
*/
|
|
2978
3226
|
declare class XGroupCommand<TOptions extends XGroupCommandType = XGroupCommandType> extends Command<any, XGroupReturnType<TOptions>> {
|
|
2979
3227
|
constructor([key, opts]: [key: string, opts: TOptions], commandOptions?: CommandOptions<any, any>);
|
|
@@ -2987,6 +3235,7 @@ type XInfoCommands = {
|
|
|
2987
3235
|
};
|
|
2988
3236
|
/**
|
|
2989
3237
|
* @see https://redis.io/commands/xinfo
|
|
3238
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xinfo.mdx
|
|
2990
3239
|
*/
|
|
2991
3240
|
declare class XInfoCommand extends Command<number, unknown[]> {
|
|
2992
3241
|
constructor([key, options]: [key: string, options: XInfoCommands], opts?: CommandOptions<number, unknown[]>);
|
|
@@ -2994,6 +3243,7 @@ declare class XInfoCommand extends Command<number, unknown[]> {
|
|
|
2994
3243
|
|
|
2995
3244
|
/**
|
|
2996
3245
|
* @see https://redis.io/commands/xlen
|
|
3246
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xlen.mdx
|
|
2997
3247
|
*/
|
|
2998
3248
|
declare class XLenCommand extends Command<number, number> {
|
|
2999
3249
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -3001,6 +3251,7 @@ declare class XLenCommand extends Command<number, number> {
|
|
|
3001
3251
|
|
|
3002
3252
|
/**
|
|
3003
3253
|
* @see https://redis.io/commands/xpending
|
|
3254
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xpending.mdx
|
|
3004
3255
|
*/
|
|
3005
3256
|
declare class XPendingCommand extends Command<unknown[], unknown[]> {
|
|
3006
3257
|
constructor([key, group, start, end, count, options]: [
|
|
@@ -3054,6 +3305,7 @@ type XReadOptions = XReadCommandOptions extends [infer K, infer I, ...any[]] ? K
|
|
|
3054
3305
|
] : never : never : never;
|
|
3055
3306
|
/**
|
|
3056
3307
|
* @see https://redis.io/commands/xread
|
|
3308
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xread.mdx
|
|
3057
3309
|
*/
|
|
3058
3310
|
declare class XReadCommand extends Command<number, unknown[]> {
|
|
3059
3311
|
constructor([key, id, options]: XReadOptions, opts?: CommandOptions<number, unknown[]>);
|
|
@@ -3083,6 +3335,7 @@ type XReadGroupOptions = XReadGroupCommandOptions extends [
|
|
|
3083
3335
|
] ? TKey extends string ? TId extends string ? [group: string, consumer: string, key: string, id: string, options?: Options] : never : TKey extends string[] ? TId extends string[] ? [group: string, consumer: string, key: string[], id: string[], options?: Options] : never : never : never;
|
|
3084
3336
|
/**
|
|
3085
3337
|
* @see https://redis.io/commands/xreadgroup
|
|
3338
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xreadgroup.mdx
|
|
3086
3339
|
*/
|
|
3087
3340
|
declare class XReadGroupCommand extends Command<number, unknown[]> {
|
|
3088
3341
|
constructor([group, consumer, key, id, options]: XReadGroupOptions, opts?: CommandOptions<number, unknown[]>);
|
|
@@ -3094,6 +3347,7 @@ declare class XRevRangeCommand<TData extends Record<string, Record<string, unkno
|
|
|
3094
3347
|
|
|
3095
3348
|
/**
|
|
3096
3349
|
* @see https://redis.io/commands/xtrim
|
|
3350
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xtrim.mdx
|
|
3097
3351
|
*/
|
|
3098
3352
|
type XTrimOptions = {
|
|
3099
3353
|
strategy: "MAXLEN" | "MINID";
|
|
@@ -3137,6 +3391,7 @@ type ScoreMember<TData> = {
|
|
|
3137
3391
|
};
|
|
3138
3392
|
/**
|
|
3139
3393
|
* @see https://redis.io/commands/zadd
|
|
3394
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zadd.mdx
|
|
3140
3395
|
*/
|
|
3141
3396
|
declare class ZAddCommand<TData = string> extends Command<number | null, number | null> {
|
|
3142
3397
|
constructor([key, arg1, ...arg2]: [string, Arg2<TData>, ...ScoreMember<TData>[]], opts?: CommandOptions<number | null, number | null>);
|
|
@@ -3144,6 +3399,7 @@ declare class ZAddCommand<TData = string> extends Command<number | null, number
|
|
|
3144
3399
|
|
|
3145
3400
|
/**
|
|
3146
3401
|
* @see https://redis.io/commands/zcard
|
|
3402
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zcard.mdx
|
|
3147
3403
|
*/
|
|
3148
3404
|
declare class ZCardCommand extends Command<number, number> {
|
|
3149
3405
|
constructor(cmd: [key: string], opts?: CommandOptions<number, number>);
|
|
@@ -3151,6 +3407,7 @@ declare class ZCardCommand extends Command<number, number> {
|
|
|
3151
3407
|
|
|
3152
3408
|
/**
|
|
3153
3409
|
* @see https://redis.io/commands/zcount
|
|
3410
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zcount.mdx
|
|
3154
3411
|
*/
|
|
3155
3412
|
declare class ZCountCommand extends Command<number, number> {
|
|
3156
3413
|
constructor(cmd: [key: string, min: number | string, max: number | string], opts?: CommandOptions<number, number>);
|
|
@@ -3158,6 +3415,7 @@ declare class ZCountCommand extends Command<number, number> {
|
|
|
3158
3415
|
|
|
3159
3416
|
/**
|
|
3160
3417
|
* @see https://redis.io/commands/zincrby
|
|
3418
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zincrby.mdx
|
|
3161
3419
|
*/
|
|
3162
3420
|
declare class ZIncrByCommand<TData> extends Command<number, number> {
|
|
3163
3421
|
constructor(cmd: [key: string, increment: number, member: TData], opts?: CommandOptions<number, number>);
|
|
@@ -3185,6 +3443,7 @@ declare class ZInterStoreCommand extends Command<number, number> {
|
|
|
3185
3443
|
|
|
3186
3444
|
/**
|
|
3187
3445
|
* @see https://redis.io/commands/zlexcount
|
|
3446
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zlexcount.mdx
|
|
3188
3447
|
*/
|
|
3189
3448
|
declare class ZLexCountCommand extends Command<number, number> {
|
|
3190
3449
|
constructor(cmd: [key: string, min: string, max: string], opts?: CommandOptions<number, number>);
|
|
@@ -3192,6 +3451,7 @@ declare class ZLexCountCommand extends Command<number, number> {
|
|
|
3192
3451
|
|
|
3193
3452
|
/**
|
|
3194
3453
|
* @see https://redis.io/commands/zpopmax
|
|
3454
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zpopmax.mdx
|
|
3195
3455
|
*/
|
|
3196
3456
|
declare class ZPopMaxCommand<TData> extends Command<string[], TData[]> {
|
|
3197
3457
|
constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string[], TData[]>);
|
|
@@ -3199,6 +3459,7 @@ declare class ZPopMaxCommand<TData> extends Command<string[], TData[]> {
|
|
|
3199
3459
|
|
|
3200
3460
|
/**
|
|
3201
3461
|
* @see https://redis.io/commands/zpopmin
|
|
3462
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zpopmin.mdx
|
|
3202
3463
|
*/
|
|
3203
3464
|
declare class ZPopMinCommand<TData> extends Command<string[], TData[]> {
|
|
3204
3465
|
constructor([key, count]: [key: string, count?: number], opts?: CommandOptions<string[], TData[]>);
|
|
@@ -3225,6 +3486,10 @@ type ZRangeCommandOptions = {
|
|
|
3225
3486
|
});
|
|
3226
3487
|
/**
|
|
3227
3488
|
* @see https://redis.io/commands/zrange
|
|
3489
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrange.mdx
|
|
3490
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
3491
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
3492
|
+
* to receive raw strings.
|
|
3228
3493
|
*/
|
|
3229
3494
|
declare class ZRangeCommand<TData extends unknown[]> extends Command<string[], TData> {
|
|
3230
3495
|
constructor(cmd: [key: string, min: number, max: number, opts?: ZRangeCommandOptions], cmdOpts?: CommandOptions<string[], TData>);
|
|
@@ -3255,6 +3520,7 @@ declare class ZRankCommand<TData> extends Command<number | null, number | null>
|
|
|
3255
3520
|
|
|
3256
3521
|
/**
|
|
3257
3522
|
* @see https://redis.io/commands/zrem
|
|
3523
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrem.mdx
|
|
3258
3524
|
*/
|
|
3259
3525
|
declare class ZRemCommand<TData = string> extends Command<number, number> {
|
|
3260
3526
|
constructor(cmd: [key: string, ...members: TData[]], opts?: CommandOptions<number, number>);
|
|
@@ -3262,6 +3528,7 @@ declare class ZRemCommand<TData = string> extends Command<number, number> {
|
|
|
3262
3528
|
|
|
3263
3529
|
/**
|
|
3264
3530
|
* @see https://redis.io/commands/zremrangebylex
|
|
3531
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebylex.mdx
|
|
3265
3532
|
*/
|
|
3266
3533
|
declare class ZRemRangeByLexCommand extends Command<number, number> {
|
|
3267
3534
|
constructor(cmd: [key: string, min: string, max: string], opts?: CommandOptions<number, number>);
|
|
@@ -3269,6 +3536,7 @@ declare class ZRemRangeByLexCommand extends Command<number, number> {
|
|
|
3269
3536
|
|
|
3270
3537
|
/**
|
|
3271
3538
|
* @see https://redis.io/commands/zremrangebyrank
|
|
3539
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyrank.mdx
|
|
3272
3540
|
*/
|
|
3273
3541
|
declare class ZRemRangeByRankCommand extends Command<number, number> {
|
|
3274
3542
|
constructor(cmd: [key: string, start: number, stop: number], opts?: CommandOptions<number, number>);
|
|
@@ -3276,6 +3544,7 @@ declare class ZRemRangeByRankCommand extends Command<number, number> {
|
|
|
3276
3544
|
|
|
3277
3545
|
/**
|
|
3278
3546
|
* @see https://redis.io/commands/zremrangebyscore
|
|
3547
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyscore.mdx
|
|
3279
3548
|
*/
|
|
3280
3549
|
declare class ZRemRangeByScoreCommand extends Command<number, number> {
|
|
3281
3550
|
constructor(cmd: [
|
|
@@ -3294,6 +3563,7 @@ declare class ZRevRankCommand<TData> extends Command<number | null, number | nul
|
|
|
3294
3563
|
|
|
3295
3564
|
/**
|
|
3296
3565
|
* @see https://redis.io/commands/zscan
|
|
3566
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zscan.mdx
|
|
3297
3567
|
*/
|
|
3298
3568
|
declare class ZScanCommand extends Command<[
|
|
3299
3569
|
string,
|
|
@@ -3307,6 +3577,7 @@ declare class ZScanCommand extends Command<[
|
|
|
3307
3577
|
|
|
3308
3578
|
/**
|
|
3309
3579
|
* @see https://redis.io/commands/zscore
|
|
3580
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zscore.mdx
|
|
3310
3581
|
*/
|
|
3311
3582
|
declare class ZScoreCommand<TData> extends Command<string | null, number | null> {
|
|
3312
3583
|
constructor(cmd: [key: string, member: TData], opts?: CommandOptions<string | null, number | null>);
|
|
@@ -3347,6 +3618,7 @@ type ZUnionStoreCommandOptions = {
|
|
|
3347
3618
|
});
|
|
3348
3619
|
/**
|
|
3349
3620
|
* @see https://redis.io/commands/zunionstore
|
|
3621
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zunionstore.mdx
|
|
3350
3622
|
*/
|
|
3351
3623
|
declare class ZUnionStoreCommand extends Command<number, number> {
|
|
3352
3624
|
constructor(cmd: [destination: string, numKeys: 1, key: string, opts?: ZUnionStoreCommandOptions], cmdOpts?: CommandOptions<number, number>);
|
|
@@ -3392,6 +3664,7 @@ declare class Subscriber<TMessage = any> extends EventTarget {
|
|
|
3392
3664
|
|
|
3393
3665
|
/**
|
|
3394
3666
|
* @see https://redis.io/commands/zdiffstore
|
|
3667
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zdiffstore.mdx
|
|
3395
3668
|
*/
|
|
3396
3669
|
declare class ZDiffStoreCommand extends Command<number, number> {
|
|
3397
3670
|
constructor(cmd: [destination: string, numkeys: number, ...keys: string[]], opts?: CommandOptions<number, number>);
|
|
@@ -3399,6 +3672,7 @@ declare class ZDiffStoreCommand extends Command<number, number> {
|
|
|
3399
3672
|
|
|
3400
3673
|
/**
|
|
3401
3674
|
* @see https://redis.io/commands/zmscore
|
|
3675
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zmscore.mdx
|
|
3402
3676
|
*/
|
|
3403
3677
|
declare class ZMScoreCommand<TData> extends Command<string[] | null, number[] | null> {
|
|
3404
3678
|
constructor(cmd: [key: string, members: TData[]], opts?: CommandOptions<string[] | null, number[] | null>);
|
|
@@ -3500,82 +3774,102 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3500
3774
|
private chain;
|
|
3501
3775
|
/**
|
|
3502
3776
|
* @see https://redis.io/commands/append
|
|
3777
|
+
* @see node_modules/@upstash/redis/docs/commands/string/append.mdx
|
|
3503
3778
|
*/
|
|
3504
3779
|
append: (...args: CommandArgs<typeof AppendCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3505
3780
|
/**
|
|
3506
3781
|
* @see https://upstash.com/docs/redis/commands/array/arcount
|
|
3782
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arcount.mdx
|
|
3507
3783
|
*/
|
|
3508
3784
|
arcount: (...args: CommandArgs<typeof ArCountCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3509
3785
|
/**
|
|
3510
3786
|
* @see https://upstash.com/docs/redis/commands/array/ardel
|
|
3787
|
+
* @see node_modules/@upstash/redis/docs/commands/array/ardel.mdx
|
|
3511
3788
|
*/
|
|
3512
3789
|
ardel: (...args: CommandArgs<typeof ArDelCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3513
3790
|
/**
|
|
3514
3791
|
* @see https://upstash.com/docs/redis/commands/array/ardelrange
|
|
3792
|
+
* @see node_modules/@upstash/redis/docs/commands/array/ardelrange.mdx
|
|
3515
3793
|
*/
|
|
3516
3794
|
ardelrange: (...args: CommandArgs<typeof ArDelRangeCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3517
3795
|
/**
|
|
3518
3796
|
* @see https://upstash.com/docs/redis/commands/array/arget
|
|
3797
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arget.mdx
|
|
3519
3798
|
*/
|
|
3520
3799
|
arget: <TData = string>(...args: CommandArgs<typeof ArGetCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3521
3800
|
/**
|
|
3522
3801
|
* @see https://upstash.com/docs/redis/commands/array/argetrange
|
|
3802
|
+
* @see node_modules/@upstash/redis/docs/commands/array/argetrange.mdx
|
|
3523
3803
|
*/
|
|
3524
3804
|
argetrange: <TData = string>(...args: CommandArgs<typeof ArGetRangeCommand>) => Pipeline<[...TCommands, Command<any, (TData | null)[]>]>;
|
|
3525
3805
|
/**
|
|
3526
3806
|
* @see https://upstash.com/docs/redis/commands/array/argrep
|
|
3807
|
+
* @see node_modules/@upstash/redis/docs/commands/array/argrep.mdx
|
|
3527
3808
|
*/
|
|
3528
3809
|
argrep: <TData = string, TOpts extends ArGrepOptions = ArGrepOptions>(key: string, start: number | string, end: number | string, opts: TOpts) => Pipeline<[...TCommands, Command<any, ArGrepResult<TData, TOpts>>]>;
|
|
3529
3810
|
/**
|
|
3530
3811
|
* @see https://upstash.com/docs/redis/commands/array/arinfo
|
|
3812
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arinfo.mdx
|
|
3531
3813
|
*/
|
|
3532
3814
|
arinfo: (...args: CommandArgs<typeof ArInfoCommand>) => Pipeline<[...TCommands, Command<any, ArInfoResult>]>;
|
|
3533
3815
|
/**
|
|
3534
3816
|
* @see https://upstash.com/docs/redis/commands/array/arinsert
|
|
3817
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arinsert.mdx
|
|
3535
3818
|
*/
|
|
3536
3819
|
arinsert: <TData>(key: string, ...values: TData[]) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3537
3820
|
/**
|
|
3538
3821
|
* @see https://upstash.com/docs/redis/commands/array/arlastitems
|
|
3822
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arlastitems.mdx
|
|
3539
3823
|
*/
|
|
3540
3824
|
arlastitems: <TData = string>(...args: CommandArgs<typeof ArLastItemsCommand>) => Pipeline<[...TCommands, Command<any, (TData | null)[]>]>;
|
|
3541
3825
|
/**
|
|
3542
3826
|
* @see https://upstash.com/docs/redis/commands/array/arlen
|
|
3827
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arlen.mdx
|
|
3543
3828
|
*/
|
|
3544
3829
|
arlen: (...args: CommandArgs<typeof ArLenCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3545
3830
|
/**
|
|
3546
3831
|
* @see https://upstash.com/docs/redis/commands/array/armget
|
|
3832
|
+
* @see node_modules/@upstash/redis/docs/commands/array/armget.mdx
|
|
3547
3833
|
*/
|
|
3548
3834
|
armget: <TData = string>(...args: CommandArgs<typeof ArMGetCommand>) => Pipeline<[...TCommands, Command<any, (TData | null)[]>]>;
|
|
3549
3835
|
/**
|
|
3550
3836
|
* @see https://upstash.com/docs/redis/commands/array/armset
|
|
3837
|
+
* @see node_modules/@upstash/redis/docs/commands/array/armset.mdx
|
|
3551
3838
|
*/
|
|
3552
3839
|
armset: <TData>(key: string, values: ArMSetValues<TData>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3553
3840
|
/**
|
|
3554
3841
|
* @see https://upstash.com/docs/redis/commands/array/arnext
|
|
3842
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arnext.mdx
|
|
3555
3843
|
*/
|
|
3556
3844
|
arnext: (...args: CommandArgs<typeof ArNextCommand>) => Pipeline<[...TCommands, Command<any, string | null>]>;
|
|
3557
3845
|
/**
|
|
3558
3846
|
* @see https://upstash.com/docs/redis/commands/array/arop
|
|
3847
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arop.mdx
|
|
3559
3848
|
*/
|
|
3560
3849
|
arop: <TData = string>(key: string, start: number | string, end: number | string, operation: ArOpOperation<TData>) => Pipeline<[...TCommands, Command<any, number | null>]>;
|
|
3561
3850
|
/**
|
|
3562
3851
|
* @see https://upstash.com/docs/redis/commands/array/arring
|
|
3852
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arring.mdx
|
|
3563
3853
|
*/
|
|
3564
3854
|
arring: <TData>(key: string, size: number, ...values: TData[]) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3565
3855
|
/**
|
|
3566
3856
|
* @see https://upstash.com/docs/redis/commands/array/arscan
|
|
3857
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arscan.mdx
|
|
3567
3858
|
*/
|
|
3568
3859
|
arscan: <TData = string>(...args: CommandArgs<typeof ArScanCommand>) => Pipeline<[...TCommands, Command<any, [string, TData][]>]>;
|
|
3569
3860
|
/**
|
|
3570
3861
|
* @see https://upstash.com/docs/redis/commands/array/arseek
|
|
3862
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arseek.mdx
|
|
3571
3863
|
*/
|
|
3572
3864
|
arseek: (...args: CommandArgs<typeof ArSeekCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3573
3865
|
/**
|
|
3574
3866
|
* @see https://upstash.com/docs/redis/commands/array/arset
|
|
3867
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arset.mdx
|
|
3575
3868
|
*/
|
|
3576
3869
|
arset: <TData>(key: string, index: number | string, ...values: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3577
3870
|
/**
|
|
3578
3871
|
* @see https://redis.io/commands/bitcount
|
|
3872
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitcount.mdx
|
|
3579
3873
|
*/
|
|
3580
3874
|
bitcount: (...args: CommandArgs<typeof BitCountCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3581
3875
|
/**
|
|
@@ -3597,6 +3891,7 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3597
3891
|
bitfield: (...args: CommandArgs<typeof BitFieldCommand>) => BitFieldCommand<Pipeline<[...TCommands, Command<any, number[]>]>>;
|
|
3598
3892
|
/**
|
|
3599
3893
|
* @see https://redis.io/commands/bitop
|
|
3894
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitop.mdx
|
|
3600
3895
|
*/
|
|
3601
3896
|
bitop: {
|
|
3602
3897
|
(op: "and" | "or" | "xor", destinationKey: string, sourceKey: string, ...sourceKeys: string[]): Pipeline<[...TCommands, BitOpCommand]>;
|
|
@@ -3606,10 +3901,12 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3606
3901
|
};
|
|
3607
3902
|
/**
|
|
3608
3903
|
* @see https://redis.io/commands/bitpos
|
|
3904
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitpos.mdx
|
|
3609
3905
|
*/
|
|
3610
3906
|
bitpos: (...args: CommandArgs<typeof BitPosCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3611
3907
|
/**
|
|
3612
3908
|
* @see https://redis.io/commands/client-setinfo
|
|
3909
|
+
* @see node_modules/@upstash/redis/docs/commands/connection/client_setinfo.mdx
|
|
3613
3910
|
*/
|
|
3614
3911
|
clientSetinfo: (...args: CommandArgs<typeof ClientSetInfoCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3615
3912
|
/**
|
|
@@ -3618,62 +3915,89 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3618
3915
|
copy: (...args: CommandArgs<typeof CopyCommand>) => Pipeline<[...TCommands, Command<any, "COPIED" | "NOT_COPIED">]>;
|
|
3619
3916
|
/**
|
|
3620
3917
|
* @see https://redis.io/commands/zdiffstore
|
|
3918
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zdiffstore.mdx
|
|
3621
3919
|
*/
|
|
3622
3920
|
zdiffstore: (...args: CommandArgs<typeof ZDiffStoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3623
3921
|
/**
|
|
3624
3922
|
* @see https://redis.io/commands/dbsize
|
|
3923
|
+
* @see node_modules/@upstash/redis/docs/commands/server/dbsize.mdx
|
|
3625
3924
|
*/
|
|
3626
3925
|
dbsize: () => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3627
3926
|
/**
|
|
3628
3927
|
* @see https://redis.io/commands/decr
|
|
3928
|
+
* @see node_modules/@upstash/redis/docs/commands/string/decr.mdx
|
|
3629
3929
|
*/
|
|
3630
3930
|
decr: (...args: CommandArgs<typeof DecrCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3631
3931
|
/**
|
|
3632
3932
|
* @see https://redis.io/commands/decrby
|
|
3933
|
+
* @see node_modules/@upstash/redis/docs/commands/string/decrby.mdx
|
|
3633
3934
|
*/
|
|
3634
3935
|
decrby: (...args: CommandArgs<typeof DecrByCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3635
3936
|
/**
|
|
3636
3937
|
* @see https://redis.io/commands/del
|
|
3938
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/del.mdx
|
|
3637
3939
|
*/
|
|
3638
3940
|
del: (...args: CommandArgs<typeof DelCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3639
3941
|
/**
|
|
3640
3942
|
* @see https://redis.io/commands/echo
|
|
3943
|
+
* @see node_modules/@upstash/redis/docs/commands/auth/echo.mdx
|
|
3641
3944
|
*/
|
|
3642
3945
|
echo: (...args: CommandArgs<typeof EchoCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3643
3946
|
/**
|
|
3644
3947
|
* @see https://redis.io/commands/eval_ro
|
|
3948
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/eval_ro.mdx
|
|
3949
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
3950
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
3951
|
+
* to receive raw strings.
|
|
3645
3952
|
*/
|
|
3646
3953
|
evalRo: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3647
3954
|
/**
|
|
3648
3955
|
* @see https://redis.io/commands/eval
|
|
3956
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/eval.mdx
|
|
3957
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
3958
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
3959
|
+
* to receive raw strings.
|
|
3649
3960
|
*/
|
|
3650
3961
|
eval: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3651
3962
|
/**
|
|
3652
3963
|
* @see https://redis.io/commands/evalsha_ro
|
|
3964
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/evalsha_ro.mdx
|
|
3965
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
3966
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
3967
|
+
* to receive raw strings.
|
|
3653
3968
|
*/
|
|
3654
3969
|
evalshaRo: <TArgs extends unknown[], TData = unknown>(...args: [sha1: string, keys: string[], args: TArgs]) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3655
3970
|
/**
|
|
3656
3971
|
* @see https://redis.io/commands/evalsha
|
|
3972
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/evalsha.mdx
|
|
3973
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
3974
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
3975
|
+
* to receive raw strings.
|
|
3657
3976
|
*/
|
|
3658
3977
|
evalsha: <TArgs extends unknown[], TData = unknown>(...args: [sha1: string, keys: string[], args: TArgs]) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3659
3978
|
/**
|
|
3660
3979
|
* @see https://redis.io/commands/exists
|
|
3980
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/exists.mdx
|
|
3661
3981
|
*/
|
|
3662
3982
|
exists: (...args: CommandArgs<typeof ExistsCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3663
3983
|
/**
|
|
3664
3984
|
* @see https://redis.io/commands/expire
|
|
3985
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/expire.mdx
|
|
3665
3986
|
*/
|
|
3666
3987
|
expire: (...args: CommandArgs<typeof ExpireCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3667
3988
|
/**
|
|
3668
3989
|
* @see https://redis.io/commands/expireat
|
|
3990
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/expireat.mdx
|
|
3669
3991
|
*/
|
|
3670
3992
|
expireat: (...args: CommandArgs<typeof ExpireAtCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3671
3993
|
/**
|
|
3672
3994
|
* @see https://redis.io/commands/flushall
|
|
3995
|
+
* @see node_modules/@upstash/redis/docs/commands/server/flushall.mdx
|
|
3673
3996
|
*/
|
|
3674
3997
|
flushall: (args?: CommandArgs<typeof FlushAllCommand>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3675
3998
|
/**
|
|
3676
3999
|
* @see https://redis.io/commands/flushdb
|
|
4000
|
+
* @see node_modules/@upstash/redis/docs/commands/server/flushdb.mdx
|
|
3677
4001
|
*/
|
|
3678
4002
|
flushdb: (...args: CommandArgs<typeof FlushDBCommand>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3679
4003
|
/**
|
|
@@ -3714,106 +4038,166 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3714
4038
|
geosearchstore: <TData>(...args: CommandArgs<typeof GeoSearchStoreCommand<TData>>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3715
4039
|
/**
|
|
3716
4040
|
* @see https://redis.io/commands/get
|
|
4041
|
+
* @see node_modules/@upstash/redis/docs/commands/string/get.mdx
|
|
4042
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4043
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4044
|
+
* to receive raw strings.
|
|
3717
4045
|
*/
|
|
3718
4046
|
get: <TData>(...args: CommandArgs<typeof GetCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3719
4047
|
/**
|
|
3720
4048
|
* @see https://redis.io/commands/getbit
|
|
4049
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/getbit.mdx
|
|
3721
4050
|
*/
|
|
3722
4051
|
getbit: (...args: CommandArgs<typeof GetBitCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3723
4052
|
/**
|
|
3724
4053
|
* @see https://redis.io/commands/getdel
|
|
4054
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getdel.mdx
|
|
4055
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4056
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4057
|
+
* to receive raw strings.
|
|
3725
4058
|
*/
|
|
3726
4059
|
getdel: <TData>(...args: CommandArgs<typeof GetDelCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3727
4060
|
/**
|
|
3728
4061
|
* @see https://redis.io/commands/getex
|
|
4062
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4063
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4064
|
+
* to receive raw strings.
|
|
3729
4065
|
*/
|
|
3730
4066
|
getex: <TData>(...args: CommandArgs<typeof GetExCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3731
4067
|
/**
|
|
3732
4068
|
* @see https://redis.io/commands/getrange
|
|
4069
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getrange.mdx
|
|
3733
4070
|
*/
|
|
3734
4071
|
getrange: (...args: CommandArgs<typeof GetRangeCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3735
4072
|
/**
|
|
3736
4073
|
* @see https://redis.io/commands/getset
|
|
4074
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getset.mdx
|
|
4075
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4076
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4077
|
+
* to receive raw strings.
|
|
3737
4078
|
*/
|
|
3738
4079
|
getset: <TData>(key: string, value: TData) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3739
4080
|
/**
|
|
3740
4081
|
* @see https://redis.io/commands/hdel
|
|
4082
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hdel.mdx
|
|
3741
4083
|
*/
|
|
3742
4084
|
hdel: (...args: CommandArgs<typeof HDelCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3743
4085
|
/**
|
|
3744
4086
|
* @see https://redis.io/commands/hexists
|
|
4087
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexists.mdx
|
|
3745
4088
|
*/
|
|
3746
4089
|
hexists: (...args: CommandArgs<typeof HExistsCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3747
4090
|
/**
|
|
3748
4091
|
* @see https://redis.io/commands/hexpire
|
|
4092
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexpire.mdx
|
|
3749
4093
|
*/
|
|
3750
4094
|
hexpire: (...args: CommandArgs<typeof HExpireCommand>) => Pipeline<[...TCommands, Command<any, (0 | 1 | 2 | -2)[]>]>;
|
|
3751
4095
|
/**
|
|
3752
4096
|
* @see https://redis.io/commands/hexpireat
|
|
4097
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexpireat.mdx
|
|
3753
4098
|
*/
|
|
3754
4099
|
hexpireat: (...args: CommandArgs<typeof HExpireAtCommand>) => Pipeline<[...TCommands, Command<any, (0 | 1 | 2 | -2)[]>]>;
|
|
3755
4100
|
/**
|
|
3756
4101
|
* @see https://redis.io/commands/hexpiretime
|
|
4102
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexpiretime.mdx
|
|
3757
4103
|
*/
|
|
3758
4104
|
hexpiretime: (...args: CommandArgs<typeof HExpireTimeCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
3759
4105
|
/**
|
|
3760
4106
|
* @see https://redis.io/commands/httl
|
|
4107
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/httl.mdx
|
|
3761
4108
|
*/
|
|
3762
4109
|
httl: (...args: CommandArgs<typeof HTtlCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
3763
4110
|
/**
|
|
3764
4111
|
* @see https://redis.io/commands/hpexpire
|
|
4112
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpexpire.mdx
|
|
3765
4113
|
*/
|
|
3766
4114
|
hpexpire: (...args: CommandArgs<typeof HPExpireCommand>) => Pipeline<[...TCommands, Command<any, (0 | 1 | 2 | -2)[]>]>;
|
|
3767
4115
|
/**
|
|
3768
4116
|
* @see https://redis.io/commands/hpexpireat
|
|
4117
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpexpireat.mdx
|
|
3769
4118
|
*/
|
|
3770
4119
|
hpexpireat: (...args: CommandArgs<typeof HPExpireAtCommand>) => Pipeline<[...TCommands, Command<any, (0 | 1 | 2 | -2)[]>]>;
|
|
3771
4120
|
/**
|
|
3772
4121
|
* @see https://redis.io/commands/hpexpiretime
|
|
4122
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpexpiretime.mdx
|
|
3773
4123
|
*/
|
|
3774
4124
|
hpexpiretime: (...args: CommandArgs<typeof HPExpireTimeCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
3775
4125
|
/**
|
|
3776
4126
|
* @see https://redis.io/commands/hpttl
|
|
4127
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpttl.mdx
|
|
3777
4128
|
*/
|
|
3778
4129
|
hpttl: (...args: CommandArgs<typeof HPTtlCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
3779
4130
|
/**
|
|
3780
4131
|
* @see https://redis.io/commands/hpersist
|
|
4132
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpersist.mdx
|
|
3781
4133
|
*/
|
|
3782
4134
|
hpersist: (...args: CommandArgs<typeof HPersistCommand>) => Pipeline<[...TCommands, Command<any, (1 | -2 | -1)[]>]>;
|
|
3783
4135
|
/**
|
|
3784
4136
|
* @see https://redis.io/commands/hget
|
|
4137
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hget.mdx
|
|
4138
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4139
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4140
|
+
* to receive raw strings.
|
|
3785
4141
|
*/
|
|
3786
4142
|
hget: <TData>(...args: CommandArgs<typeof HGetCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3787
4143
|
/**
|
|
3788
4144
|
* @see https://redis.io/commands/hgetall
|
|
4145
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetall.mdx
|
|
4146
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4147
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4148
|
+
* to receive raw strings.
|
|
4149
|
+
* With automaticDeserialization: false, hgetall returns a flat array instead, such as
|
|
4150
|
+
* ["text", "123", "version", "1"], and [] for a missing key.
|
|
3789
4151
|
*/
|
|
3790
4152
|
hgetall: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HGetAllCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3791
4153
|
/**
|
|
3792
4154
|
* @see https://redis.io/commands/hgetdel
|
|
4155
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetdel.mdx
|
|
4156
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4157
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4158
|
+
* to receive raw strings.
|
|
4159
|
+
* With automaticDeserialization: false, hgetdel returns an array of values in field order instead,
|
|
4160
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
3793
4161
|
*/
|
|
3794
4162
|
hgetdel: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HGetDelCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3795
4163
|
/**
|
|
3796
4164
|
* @see https://redis.io/commands/hgetex
|
|
4165
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetex.mdx
|
|
4166
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4167
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4168
|
+
* to receive raw strings.
|
|
4169
|
+
* With automaticDeserialization: false, hgetex returns an array of values in field order instead,
|
|
4170
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
3797
4171
|
*/
|
|
3798
4172
|
hgetex: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HGetExCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3799
4173
|
/**
|
|
3800
4174
|
* @see https://redis.io/commands/hincrby
|
|
4175
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hincrby.mdx
|
|
3801
4176
|
*/
|
|
3802
4177
|
hincrby: (...args: CommandArgs<typeof HIncrByCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3803
4178
|
/**
|
|
3804
4179
|
* @see https://redis.io/commands/hincrbyfloat
|
|
4180
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hincrbyfloat.mdx
|
|
3805
4181
|
*/
|
|
3806
4182
|
hincrbyfloat: (...args: CommandArgs<typeof HIncrByFloatCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3807
4183
|
/**
|
|
3808
4184
|
* @see https://redis.io/commands/hkeys
|
|
4185
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hkeys.mdx
|
|
3809
4186
|
*/
|
|
3810
4187
|
hkeys: (...args: CommandArgs<typeof HKeysCommand>) => Pipeline<[...TCommands, Command<any, string[]>]>;
|
|
3811
4188
|
/**
|
|
3812
4189
|
* @see https://redis.io/commands/hlen
|
|
4190
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hlen.mdx
|
|
3813
4191
|
*/
|
|
3814
4192
|
hlen: (...args: CommandArgs<typeof HLenCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3815
4193
|
/**
|
|
3816
4194
|
* @see https://redis.io/commands/hmget
|
|
4195
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hmget.mdx
|
|
4196
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4197
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4198
|
+
* to receive raw strings.
|
|
4199
|
+
* With automaticDeserialization: false, hmget returns an array of values in field order instead,
|
|
4200
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
3817
4201
|
*/
|
|
3818
4202
|
hmget: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HMGetCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3819
4203
|
/**
|
|
@@ -3822,66 +4206,88 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3822
4206
|
hmset: <TData>(key: string, kv: Record<string, TData>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3823
4207
|
/**
|
|
3824
4208
|
* @see https://redis.io/commands/hrandfield
|
|
4209
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hrandfield.mdx
|
|
3825
4210
|
*/
|
|
3826
4211
|
hrandfield: <TData extends string | string[] | Record<string, unknown>>(key: string, count?: number, withValues?: boolean) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3827
4212
|
/**
|
|
3828
4213
|
* @see https://redis.io/commands/hscan
|
|
4214
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hscan.mdx
|
|
3829
4215
|
*/
|
|
3830
4216
|
hscan: (...args: CommandArgs<typeof HScanCommand>) => Pipeline<[...TCommands, Command<any, [string, (string | number)[]]>]>;
|
|
3831
4217
|
/**
|
|
3832
4218
|
* @see https://redis.io/commands/hset
|
|
4219
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hset.mdx
|
|
3833
4220
|
*/
|
|
3834
4221
|
hset: <TData>(key: string, kv: Record<string, TData>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3835
4222
|
/**
|
|
3836
4223
|
* @see https://redis.io/commands/hsetex
|
|
4224
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hsetex.mdx
|
|
3837
4225
|
*/
|
|
3838
4226
|
hsetex: <TData>(...args: CommandArgs<typeof HSetExCommand<TData>>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3839
4227
|
/**
|
|
3840
4228
|
* @see https://redis.io/commands/hsetnx
|
|
4229
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hsetnx.mdx
|
|
3841
4230
|
*/
|
|
3842
4231
|
hsetnx: <TData>(key: string, field: string, value: TData) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3843
4232
|
/**
|
|
3844
4233
|
* @see https://redis.io/commands/hstrlen
|
|
4234
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hstrlen.mdx
|
|
3845
4235
|
*/
|
|
3846
4236
|
hstrlen: (...args: CommandArgs<typeof HStrLenCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3847
4237
|
/**
|
|
3848
4238
|
* @see https://redis.io/commands/hvals
|
|
4239
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hvals.mdx
|
|
3849
4240
|
*/
|
|
3850
4241
|
hvals: (...args: CommandArgs<typeof HValsCommand>) => Pipeline<[...TCommands, Command<any, any>]>;
|
|
3851
4242
|
/**
|
|
3852
4243
|
* @see https://redis.io/commands/incr
|
|
4244
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incr.mdx
|
|
3853
4245
|
*/
|
|
3854
4246
|
incr: (...args: CommandArgs<typeof IncrCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3855
4247
|
/**
|
|
3856
4248
|
* @see https://redis.io/commands/incrby
|
|
4249
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incrby.mdx
|
|
3857
4250
|
*/
|
|
3858
4251
|
incrby: (...args: CommandArgs<typeof IncrByCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3859
4252
|
/**
|
|
3860
4253
|
* @see https://redis.io/commands/incrbyfloat
|
|
4254
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incrbyfloat.mdx
|
|
3861
4255
|
*/
|
|
3862
4256
|
incrbyfloat: (...args: CommandArgs<typeof IncrByFloatCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3863
4257
|
/**
|
|
3864
4258
|
* @see https://redis.io/commands/keys
|
|
4259
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/keys.mdx
|
|
3865
4260
|
*/
|
|
3866
4261
|
keys: (...args: CommandArgs<typeof KeysCommand>) => Pipeline<[...TCommands, Command<any, string[]>]>;
|
|
3867
4262
|
/**
|
|
3868
4263
|
* @see https://redis.io/commands/lindex
|
|
4264
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lindex.mdx
|
|
4265
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4266
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4267
|
+
* to receive raw strings.
|
|
3869
4268
|
*/
|
|
3870
4269
|
lindex: (...args: CommandArgs<typeof LIndexCommand>) => Pipeline<[...TCommands, Command<any, any>]>;
|
|
3871
4270
|
/**
|
|
3872
4271
|
* @see https://redis.io/commands/linsert
|
|
4272
|
+
* @see node_modules/@upstash/redis/docs/commands/list/linsert.mdx
|
|
3873
4273
|
*/
|
|
3874
4274
|
linsert: <TData>(key: string, direction: "before" | "after", pivot: TData, value: TData) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3875
4275
|
/**
|
|
3876
4276
|
* @see https://redis.io/commands/llen
|
|
4277
|
+
* @see node_modules/@upstash/redis/docs/commands/list/llen.mdx
|
|
3877
4278
|
*/
|
|
3878
4279
|
llen: (...args: CommandArgs<typeof LLenCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3879
4280
|
/**
|
|
3880
4281
|
* @see https://redis.io/commands/lmove
|
|
4282
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lmove.mdx
|
|
3881
4283
|
*/
|
|
3882
4284
|
lmove: <TData = string>(...args: CommandArgs<typeof LMoveCommand>) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3883
4285
|
/**
|
|
3884
4286
|
* @see https://redis.io/commands/lpop
|
|
4287
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpop.mdx
|
|
4288
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4289
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4290
|
+
* to receive raw strings.
|
|
3885
4291
|
*/
|
|
3886
4292
|
lpop: <TData>(...args: CommandArgs<typeof LPopCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3887
4293
|
/**
|
|
@@ -3890,54 +4296,73 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3890
4296
|
lmpop: <TData>(...args: CommandArgs<typeof LmPopCommand>) => Pipeline<[...TCommands, Command<any, [string, TData[]] | null>]>;
|
|
3891
4297
|
/**
|
|
3892
4298
|
* @see https://redis.io/commands/lpos
|
|
4299
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpos.mdx
|
|
3893
4300
|
*/
|
|
3894
4301
|
lpos: <TData>(...args: CommandArgs<typeof LPosCommand>) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3895
4302
|
/**
|
|
3896
4303
|
* @see https://redis.io/commands/lpush
|
|
4304
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpush.mdx
|
|
3897
4305
|
*/
|
|
3898
4306
|
lpush: <TData>(key: string, ...elements: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3899
4307
|
/**
|
|
3900
4308
|
* @see https://redis.io/commands/lpushx
|
|
4309
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpushx.mdx
|
|
3901
4310
|
*/
|
|
3902
4311
|
lpushx: <TData>(key: string, ...elements: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3903
4312
|
/**
|
|
3904
4313
|
* @see https://redis.io/commands/lrange
|
|
4314
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lrange.mdx
|
|
4315
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4316
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4317
|
+
* to receive raw strings.
|
|
3905
4318
|
*/
|
|
3906
4319
|
lrange: <TResult = string>(...args: CommandArgs<typeof LRangeCommand>) => Pipeline<[...TCommands, Command<any, TResult[]>]>;
|
|
3907
4320
|
/**
|
|
3908
4321
|
* @see https://redis.io/commands/lrem
|
|
4322
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lrem.mdx
|
|
3909
4323
|
*/
|
|
3910
4324
|
lrem: <TData>(key: string, count: number, value: TData) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3911
4325
|
/**
|
|
3912
4326
|
* @see https://redis.io/commands/lset
|
|
4327
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lset.mdx
|
|
3913
4328
|
*/
|
|
3914
4329
|
lset: <TData>(key: string, index: number, value: TData) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3915
4330
|
/**
|
|
3916
4331
|
* @see https://redis.io/commands/ltrim
|
|
4332
|
+
* @see node_modules/@upstash/redis/docs/commands/list/ltrim.mdx
|
|
3917
4333
|
*/
|
|
3918
4334
|
ltrim: (...args: CommandArgs<typeof LTrimCommand>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3919
4335
|
/**
|
|
3920
4336
|
* @see https://redis.io/commands/mget
|
|
4337
|
+
* @see node_modules/@upstash/redis/docs/commands/string/mget.mdx
|
|
4338
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4339
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4340
|
+
* to receive raw strings.
|
|
3921
4341
|
*/
|
|
3922
4342
|
mget: <TData extends unknown[]>(...args: CommandArgs<typeof MGetCommand>) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
3923
4343
|
/**
|
|
3924
4344
|
* @see https://redis.io/commands/mset
|
|
4345
|
+
* @see node_modules/@upstash/redis/docs/commands/string/mset.mdx
|
|
3925
4346
|
*/
|
|
3926
4347
|
mset: <TData>(kv: Record<string, TData>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3927
4348
|
/**
|
|
3928
4349
|
* @see https://redis.io/commands/msetnx
|
|
4350
|
+
* @see node_modules/@upstash/redis/docs/commands/string/msetnx.mdx
|
|
3929
4351
|
*/
|
|
3930
4352
|
msetnx: <TData>(kv: Record<string, TData>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3931
4353
|
/**
|
|
3932
4354
|
* @see https://redis.io/commands/persist
|
|
4355
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/persist.mdx
|
|
3933
4356
|
*/
|
|
3934
4357
|
persist: (...args: CommandArgs<typeof PersistCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3935
4358
|
/**
|
|
3936
4359
|
* @see https://redis.io/commands/pexpire
|
|
4360
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pexpire.mdx
|
|
3937
4361
|
*/
|
|
3938
4362
|
pexpire: (...args: CommandArgs<typeof PExpireCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3939
4363
|
/**
|
|
3940
4364
|
* @see https://redis.io/commands/pexpireat
|
|
4365
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pexpireat.mdx
|
|
3941
4366
|
*/
|
|
3942
4367
|
pexpireat: (...args: CommandArgs<typeof PExpireAtCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3943
4368
|
/**
|
|
@@ -3954,6 +4379,7 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3954
4379
|
pfmerge: (...args: CommandArgs<typeof PfMergeCommand>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3955
4380
|
/**
|
|
3956
4381
|
* @see https://redis.io/commands/ping
|
|
4382
|
+
* @see node_modules/@upstash/redis/docs/commands/auth/ping.mdx
|
|
3957
4383
|
*/
|
|
3958
4384
|
ping: (args?: CommandArgs<typeof PingCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3959
4385
|
/**
|
|
@@ -3962,71 +4388,91 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
3962
4388
|
psetex: <TData>(key: string, ttl: number, value: TData) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
3963
4389
|
/**
|
|
3964
4390
|
* @see https://redis.io/commands/pttl
|
|
4391
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pttl.mdx
|
|
3965
4392
|
*/
|
|
3966
4393
|
pttl: (...args: CommandArgs<typeof PTtlCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3967
4394
|
/**
|
|
3968
4395
|
* @see https://redis.io/commands/publish
|
|
4396
|
+
* @see node_modules/@upstash/redis/docs/commands/pubsub/publish.mdx
|
|
3969
4397
|
*/
|
|
3970
4398
|
publish: (...args: CommandArgs<typeof PublishCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3971
4399
|
/**
|
|
3972
4400
|
* @see https://redis.io/commands/randomkey
|
|
4401
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/randomkey.mdx
|
|
3973
4402
|
*/
|
|
3974
4403
|
randomkey: () => Pipeline<[...TCommands, Command<any, string | null>]>;
|
|
3975
4404
|
/**
|
|
3976
4405
|
* @see https://redis.io/commands/rename
|
|
4406
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/rename.mdx
|
|
3977
4407
|
*/
|
|
3978
4408
|
rename: (...args: CommandArgs<typeof RenameCommand>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
3979
4409
|
/**
|
|
3980
4410
|
* @see https://redis.io/commands/renamenx
|
|
4411
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/renamenx.mdx
|
|
3981
4412
|
*/
|
|
3982
4413
|
renamenx: (...args: CommandArgs<typeof RenameNXCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
3983
4414
|
/**
|
|
3984
4415
|
* @see https://redis.io/commands/rpop
|
|
4416
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpop.mdx
|
|
4417
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4418
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4419
|
+
* to receive raw strings.
|
|
3985
4420
|
*/
|
|
3986
4421
|
rpop: <TData = string>(...args: CommandArgs<typeof RPopCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
3987
4422
|
/**
|
|
3988
4423
|
* @see https://redis.io/commands/rpush
|
|
4424
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpush.mdx
|
|
3989
4425
|
*/
|
|
3990
4426
|
rpush: <TData>(key: string, ...elements: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3991
4427
|
/**
|
|
3992
4428
|
* @see https://redis.io/commands/rpushx
|
|
4429
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpushx.mdx
|
|
3993
4430
|
*/
|
|
3994
4431
|
rpushx: <TData>(key: string, ...elements: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3995
4432
|
/**
|
|
3996
4433
|
* @see https://redis.io/commands/sadd
|
|
4434
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sadd.mdx
|
|
3997
4435
|
*/
|
|
3998
4436
|
sadd: <TData>(key: string, member: TData, ...members: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
3999
4437
|
/**
|
|
4000
4438
|
* @see https://redis.io/commands/scan
|
|
4439
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/scan.mdx
|
|
4001
4440
|
*/
|
|
4002
4441
|
scan: (...args: CommandArgs<typeof ScanCommand>) => Pipeline<[...TCommands, Command<any, any>]>;
|
|
4003
4442
|
/**
|
|
4004
4443
|
* @see https://redis.io/commands/scard
|
|
4444
|
+
* @see node_modules/@upstash/redis/docs/commands/set/scard.mdx
|
|
4005
4445
|
*/
|
|
4006
4446
|
scard: (...args: CommandArgs<typeof SCardCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4007
4447
|
/**
|
|
4008
4448
|
* @see https://redis.io/commands/script-exists
|
|
4449
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_exists.mdx
|
|
4009
4450
|
*/
|
|
4010
4451
|
scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
4011
4452
|
/**
|
|
4012
4453
|
* @see https://redis.io/commands/script-flush
|
|
4454
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_flush.mdx
|
|
4013
4455
|
*/
|
|
4014
4456
|
scriptFlush: (...args: CommandArgs<typeof ScriptFlushCommand>) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
4015
4457
|
/**
|
|
4016
4458
|
* @see https://redis.io/commands/script-load
|
|
4459
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_load.mdx
|
|
4017
4460
|
*/
|
|
4018
4461
|
scriptLoad: (...args: CommandArgs<typeof ScriptLoadCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
4019
4462
|
sdiff: (...args: CommandArgs<typeof SDiffCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4020
4463
|
/**
|
|
4021
4464
|
* @see https://redis.io/commands/sdiffstore
|
|
4465
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sdiffstore.mdx
|
|
4022
4466
|
*/
|
|
4023
4467
|
sdiffstore: (...args: CommandArgs<typeof SDiffStoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4024
4468
|
/**
|
|
4025
4469
|
* @see https://redis.io/commands/set
|
|
4470
|
+
* @see node_modules/@upstash/redis/docs/commands/string/set.mdx
|
|
4026
4471
|
*/
|
|
4027
4472
|
set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => Pipeline<[...TCommands, Command<any, "OK" | TData | null>]>;
|
|
4028
4473
|
/**
|
|
4029
4474
|
* @see https://redis.io/commands/setbit
|
|
4475
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/setbit.mdx
|
|
4030
4476
|
*/
|
|
4031
4477
|
setbit: (...args: CommandArgs<typeof SetBitCommand>) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
4032
4478
|
/**
|
|
@@ -4039,10 +4485,12 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4039
4485
|
setnx: <TData>(key: string, value: TData) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4040
4486
|
/**
|
|
4041
4487
|
* @see https://redis.io/commands/setrange
|
|
4488
|
+
* @see node_modules/@upstash/redis/docs/commands/string/setrange.mdx
|
|
4042
4489
|
*/
|
|
4043
4490
|
setrange: (...args: CommandArgs<typeof SetRangeCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4044
4491
|
/**
|
|
4045
4492
|
* @see https://redis.io/commands/sinter
|
|
4493
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sinter.mdx
|
|
4046
4494
|
*/
|
|
4047
4495
|
sinter: (...args: CommandArgs<typeof SInterCommand>) => Pipeline<[...TCommands, Command<any, string[]>]>;
|
|
4048
4496
|
/**
|
|
@@ -4051,50 +4499,62 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4051
4499
|
sintercard: (...args: CommandArgs<typeof SInterCardCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4052
4500
|
/**
|
|
4053
4501
|
* @see https://redis.io/commands/sinterstore
|
|
4502
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sinterstore.mdx
|
|
4054
4503
|
*/
|
|
4055
4504
|
sinterstore: (...args: CommandArgs<typeof SInterStoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4056
4505
|
/**
|
|
4057
4506
|
* @see https://redis.io/commands/sismember
|
|
4507
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sismember.mdx
|
|
4058
4508
|
*/
|
|
4059
4509
|
sismember: <TData>(key: string, member: TData) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
4060
4510
|
/**
|
|
4061
4511
|
* @see https://redis.io/commands/smembers
|
|
4512
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smembers.mdx
|
|
4062
4513
|
*/
|
|
4063
4514
|
smembers: <TData extends unknown[] = string[]>(...args: CommandArgs<typeof SMembersCommand>) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
4064
4515
|
/**
|
|
4065
4516
|
* @see https://redis.io/commands/smismember
|
|
4517
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smismember.mdx
|
|
4066
4518
|
*/
|
|
4067
4519
|
smismember: <TMembers extends unknown[]>(key: string, members: TMembers) => Pipeline<[...TCommands, Command<any, (0 | 1)[]>]>;
|
|
4068
4520
|
/**
|
|
4069
4521
|
* @see https://redis.io/commands/smove
|
|
4522
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smove.mdx
|
|
4070
4523
|
*/
|
|
4071
4524
|
smove: <TData>(source: string, destination: string, member: TData) => Pipeline<[...TCommands, Command<any, 0 | 1>]>;
|
|
4072
4525
|
/**
|
|
4073
4526
|
* @see https://redis.io/commands/spop
|
|
4527
|
+
* @see node_modules/@upstash/redis/docs/commands/set/spop.mdx
|
|
4074
4528
|
*/
|
|
4075
4529
|
spop: <TData>(...args: CommandArgs<typeof SPopCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
4076
4530
|
/**
|
|
4077
4531
|
* @see https://redis.io/commands/srandmember
|
|
4532
|
+
* @see node_modules/@upstash/redis/docs/commands/set/srandmember.mdx
|
|
4078
4533
|
*/
|
|
4079
4534
|
srandmember: <TData>(...args: CommandArgs<typeof SRandMemberCommand>) => Pipeline<[...TCommands, Command<any, TData | null>]>;
|
|
4080
4535
|
/**
|
|
4081
4536
|
* @see https://redis.io/commands/srem
|
|
4537
|
+
* @see node_modules/@upstash/redis/docs/commands/set/srem.mdx
|
|
4082
4538
|
*/
|
|
4083
4539
|
srem: <TData>(key: string, ...members: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4084
4540
|
/**
|
|
4085
4541
|
* @see https://redis.io/commands/sscan
|
|
4542
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sscan.mdx
|
|
4086
4543
|
*/
|
|
4087
4544
|
sscan: (...args: CommandArgs<typeof SScanCommand>) => Pipeline<[...TCommands, Command<any, [string, (string | number)[]]>]>;
|
|
4088
4545
|
/**
|
|
4089
4546
|
* @see https://redis.io/commands/strlen
|
|
4547
|
+
* @see node_modules/@upstash/redis/docs/commands/string/strlen.mdx
|
|
4090
4548
|
*/
|
|
4091
4549
|
strlen: (...args: CommandArgs<typeof StrLenCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4092
4550
|
/**
|
|
4093
4551
|
* @see https://redis.io/commands/sunion
|
|
4552
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sunion.mdx
|
|
4094
4553
|
*/
|
|
4095
4554
|
sunion: (...args: CommandArgs<typeof SUnionCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4096
4555
|
/**
|
|
4097
4556
|
* @see https://redis.io/commands/sunionstore
|
|
4557
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sunionstore.mdx
|
|
4098
4558
|
*/
|
|
4099
4559
|
sunionstore: (...args: CommandArgs<typeof SUnionStoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4100
4560
|
/**
|
|
@@ -4103,122 +4563,165 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4103
4563
|
time: () => Pipeline<[...TCommands, Command<any, [number, number]>]>;
|
|
4104
4564
|
/**
|
|
4105
4565
|
* @see https://redis.io/commands/touch
|
|
4566
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/touch.mdx
|
|
4106
4567
|
*/
|
|
4107
4568
|
touch: (...args: CommandArgs<typeof TouchCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4108
4569
|
/**
|
|
4109
4570
|
* @see https://redis.io/commands/ttl
|
|
4571
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/ttl.mdx
|
|
4110
4572
|
*/
|
|
4111
4573
|
ttl: (...args: CommandArgs<typeof TtlCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4112
4574
|
/**
|
|
4113
4575
|
* @see https://redis.io/commands/type
|
|
4576
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/type.mdx
|
|
4114
4577
|
*/
|
|
4115
4578
|
type: (...args: CommandArgs<typeof TypeCommand>) => Pipeline<[...TCommands, Command<any, Type>]>;
|
|
4116
4579
|
/**
|
|
4117
4580
|
* @see https://redis.io/commands/unlink
|
|
4581
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/unlink.mdx
|
|
4118
4582
|
*/
|
|
4119
4583
|
unlink: (...args: CommandArgs<typeof UnlinkCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4120
4584
|
/**
|
|
4121
4585
|
* @see https://redis.io/commands/zadd
|
|
4586
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zadd.mdx
|
|
4122
4587
|
*/
|
|
4123
4588
|
zadd: <TData>(...args: [key: string, scoreMember: ScoreMember<TData>, ...scoreMemberPairs: ScoreMember<TData>[]] | [key: string, opts: ZAddCommandOptions, ...scoreMemberPairs: [ScoreMember<TData>, ...ScoreMember<TData>[]]]) => Pipeline<[...TCommands, Command<any, number | null>]>;
|
|
4124
4589
|
/**
|
|
4125
4590
|
* @see https://redis.io/commands/xadd
|
|
4591
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xadd.mdx
|
|
4126
4592
|
*/
|
|
4127
4593
|
xadd: (...args: CommandArgs<typeof XAddCommand>) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
4128
4594
|
/**
|
|
4129
4595
|
* @see https://redis.io/commands/xack
|
|
4596
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xack.mdx
|
|
4130
4597
|
*/
|
|
4131
4598
|
xack: (...args: CommandArgs<typeof XAckCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4132
4599
|
/**
|
|
4133
4600
|
* @see https://redis.io/commands/xackdel
|
|
4601
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xackdel.mdx
|
|
4134
4602
|
*/
|
|
4135
4603
|
xackdel: (...args: CommandArgs<typeof XAckDelCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
4136
4604
|
/**
|
|
4137
4605
|
* @see https://redis.io/commands/xdel
|
|
4606
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xdel.mdx
|
|
4138
4607
|
*/
|
|
4139
4608
|
xdel: (...args: CommandArgs<typeof XDelCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4140
4609
|
/**
|
|
4141
4610
|
* @see https://redis.io/commands/xdelex
|
|
4611
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xdelex.mdx
|
|
4142
4612
|
*/
|
|
4143
4613
|
xdelex: (...args: CommandArgs<typeof XDelExCommand>) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
4144
4614
|
/**
|
|
4145
4615
|
* @see https://redis.io/commands/xgroup
|
|
4616
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xgroup.mdx
|
|
4146
4617
|
*/
|
|
4147
4618
|
xgroup: (...args: CommandArgs<typeof XGroupCommand>) => Pipeline<[...TCommands, Command<any, never>]>;
|
|
4148
4619
|
/**
|
|
4149
4620
|
* @see https://redis.io/commands/xread
|
|
4621
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xread.mdx
|
|
4150
4622
|
*/
|
|
4151
4623
|
xread: (...args: CommandArgs<typeof XReadCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4152
4624
|
/**
|
|
4153
4625
|
* @see https://redis.io/commands/xreadgroup
|
|
4626
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xreadgroup.mdx
|
|
4154
4627
|
*/
|
|
4155
4628
|
xreadgroup: (...args: CommandArgs<typeof XReadGroupCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4156
4629
|
/**
|
|
4157
4630
|
* @see https://redis.io/commands/xinfo
|
|
4631
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xinfo.mdx
|
|
4158
4632
|
*/
|
|
4159
4633
|
xinfo: (...args: CommandArgs<typeof XInfoCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4160
4634
|
/**
|
|
4161
4635
|
* @see https://redis.io/commands/xlen
|
|
4636
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xlen.mdx
|
|
4162
4637
|
*/
|
|
4163
4638
|
xlen: (...args: CommandArgs<typeof XLenCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4164
4639
|
/**
|
|
4165
4640
|
* @see https://redis.io/commands/xpending
|
|
4641
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xpending.mdx
|
|
4166
4642
|
*/
|
|
4167
4643
|
xpending: (...args: CommandArgs<typeof XPendingCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4168
4644
|
/**
|
|
4169
4645
|
* @see https://redis.io/commands/xclaim
|
|
4646
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xclaim.mdx
|
|
4170
4647
|
*/
|
|
4171
4648
|
xclaim: (...args: CommandArgs<typeof XClaimCommand>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4172
4649
|
/**
|
|
4173
4650
|
* @see https://redis.io/commands/xautoclaim
|
|
4651
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xautoclaim.mdx
|
|
4174
4652
|
*/
|
|
4175
4653
|
xautoclaim: (...args: CommandArgs<typeof XAutoClaim>) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4176
4654
|
/**
|
|
4177
4655
|
* @see https://redis.io/commands/xtrim
|
|
4656
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xtrim.mdx
|
|
4178
4657
|
*/
|
|
4179
4658
|
xtrim: (...args: CommandArgs<typeof XTrimCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4180
4659
|
/**
|
|
4181
4660
|
* @see https://redis.io/commands/xrange
|
|
4661
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xrange.mdx
|
|
4662
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4663
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4664
|
+
* to receive raw strings.
|
|
4665
|
+
* With automaticDeserialization: false, xrange returns [id, [field, value, ...]] entries instead,
|
|
4666
|
+
* such as [["1790341484470-0", ["text", "123"]]], and [] for a missing key.
|
|
4182
4667
|
*/
|
|
4183
4668
|
xrange: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof XRangeCommand>) => Pipeline<[...TCommands, Command<any, Record<string, TData>>]>;
|
|
4184
4669
|
/**
|
|
4185
4670
|
* @see https://redis.io/commands/xrevrange
|
|
4671
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xrevrange.mdx
|
|
4672
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4673
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4674
|
+
* to receive raw strings.
|
|
4675
|
+
* With automaticDeserialization: false, xrevrange returns [id, [field, value, ...]] entries instead,
|
|
4676
|
+
* such as [["1790341484470-0", ["text", "123"]]], and [] for a missing key.
|
|
4186
4677
|
*/
|
|
4187
4678
|
xrevrange: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof XRevRangeCommand>) => Pipeline<[...TCommands, Command<any, Record<string, TData>>]>;
|
|
4188
4679
|
/**
|
|
4189
4680
|
* @see https://redis.io/commands/zcard
|
|
4681
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zcard.mdx
|
|
4190
4682
|
*/
|
|
4191
4683
|
zcard: (...args: CommandArgs<typeof ZCardCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4192
4684
|
/**
|
|
4193
4685
|
* @see https://redis.io/commands/zcount
|
|
4686
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zcount.mdx
|
|
4194
4687
|
*/
|
|
4195
4688
|
zcount: (...args: CommandArgs<typeof ZCountCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4196
4689
|
/**
|
|
4197
4690
|
* @see https://redis.io/commands/zincrby
|
|
4691
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zincrby.mdx
|
|
4198
4692
|
*/
|
|
4199
4693
|
zincrby: <TData>(key: string, increment: number, member: TData) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4200
4694
|
/**
|
|
4201
4695
|
* @see https://redis.io/commands/zinterstore
|
|
4696
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zinterstore.mdx
|
|
4202
4697
|
*/
|
|
4203
4698
|
zinterstore: (...args: CommandArgs<typeof ZInterStoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4204
4699
|
/**
|
|
4205
4700
|
* @see https://redis.io/commands/zlexcount
|
|
4701
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zlexcount.mdx
|
|
4206
4702
|
*/
|
|
4207
4703
|
zlexcount: (...args: CommandArgs<typeof ZLexCountCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4208
4704
|
/**
|
|
4209
4705
|
* @see https://redis.io/commands/zmscore
|
|
4706
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zmscore.mdx
|
|
4210
4707
|
*/
|
|
4211
4708
|
zmscore: (...args: CommandArgs<typeof ZMScoreCommand>) => Pipeline<[...TCommands, Command<any, number[] | null>]>;
|
|
4212
4709
|
/**
|
|
4213
4710
|
* @see https://redis.io/commands/zpopmax
|
|
4711
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zpopmax.mdx
|
|
4214
4712
|
*/
|
|
4215
4713
|
zpopmax: <TData>(...args: CommandArgs<typeof ZPopMaxCommand>) => Pipeline<[...TCommands, Command<any, TData[]>]>;
|
|
4216
4714
|
/**
|
|
4217
4715
|
* @see https://redis.io/commands/zpopmin
|
|
4716
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zpopmin.mdx
|
|
4218
4717
|
*/
|
|
4219
4718
|
zpopmin: <TData>(...args: CommandArgs<typeof ZPopMinCommand>) => Pipeline<[...TCommands, Command<any, TData[]>]>;
|
|
4220
4719
|
/**
|
|
4221
4720
|
* @see https://redis.io/commands/zrange
|
|
4721
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrange.mdx
|
|
4722
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4723
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4724
|
+
* to receive raw strings.
|
|
4222
4725
|
*/
|
|
4223
4726
|
zrange: <TData extends unknown[]>(...args: [key: string, min: number, max: number, opts?: ZRangeCommandOptions] | [key: string, min: `(${string}` | `[${string}` | "-" | "+", max: `(${string}` | `[${string}` | "-" | "+", opts: {
|
|
4224
4727
|
byLex: true;
|
|
@@ -4227,38 +4730,47 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4227
4730
|
} & ZRangeCommandOptions]) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
4228
4731
|
/**
|
|
4229
4732
|
* @see https://redis.io/commands/zrank
|
|
4733
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrank.mdx
|
|
4230
4734
|
*/
|
|
4231
4735
|
zrank: <TData>(key: string, member: TData) => Pipeline<[...TCommands, Command<any, number | null>]>;
|
|
4232
4736
|
/**
|
|
4233
4737
|
* @see https://redis.io/commands/zrem
|
|
4738
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrem.mdx
|
|
4234
4739
|
*/
|
|
4235
4740
|
zrem: <TData>(key: string, ...members: TData[]) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4236
4741
|
/**
|
|
4237
4742
|
* @see https://redis.io/commands/zremrangebylex
|
|
4743
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebylex.mdx
|
|
4238
4744
|
*/
|
|
4239
4745
|
zremrangebylex: (...args: CommandArgs<typeof ZRemRangeByLexCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4240
4746
|
/**
|
|
4241
4747
|
* @see https://redis.io/commands/zremrangebyrank
|
|
4748
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyrank.mdx
|
|
4242
4749
|
*/
|
|
4243
4750
|
zremrangebyrank: (...args: CommandArgs<typeof ZRemRangeByRankCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4244
4751
|
/**
|
|
4245
4752
|
* @see https://redis.io/commands/zremrangebyscore
|
|
4753
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyscore.mdx
|
|
4246
4754
|
*/
|
|
4247
4755
|
zremrangebyscore: (...args: CommandArgs<typeof ZRemRangeByScoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4248
4756
|
/**
|
|
4249
4757
|
* @see https://redis.io/commands/zrevrank
|
|
4758
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrevrank.mdx
|
|
4250
4759
|
*/
|
|
4251
4760
|
zrevrank: <TData>(key: string, member: TData) => Pipeline<[...TCommands, Command<any, number | null>]>;
|
|
4252
4761
|
/**
|
|
4253
4762
|
* @see https://redis.io/commands/zscan
|
|
4763
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zscan.mdx
|
|
4254
4764
|
*/
|
|
4255
4765
|
zscan: (...args: CommandArgs<typeof ZScanCommand>) => Pipeline<[...TCommands, Command<any, [string, (string | number)[]]>]>;
|
|
4256
4766
|
/**
|
|
4257
4767
|
* @see https://redis.io/commands/zscore
|
|
4768
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zscore.mdx
|
|
4258
4769
|
*/
|
|
4259
4770
|
zscore: <TData>(key: string, member: TData) => Pipeline<[...TCommands, Command<any, number | null>]>;
|
|
4260
4771
|
/**
|
|
4261
4772
|
* @see https://redis.io/commands/zunionstore
|
|
4773
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zunionstore.mdx
|
|
4262
4774
|
*/
|
|
4263
4775
|
zunionstore: (...args: CommandArgs<typeof ZUnionStoreCommand>) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4264
4776
|
/**
|
|
@@ -4271,70 +4783,87 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4271
4783
|
get json(): {
|
|
4272
4784
|
/**
|
|
4273
4785
|
* @see https://redis.io/commands/json.arrappend
|
|
4786
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrappend.mdx
|
|
4274
4787
|
*/
|
|
4275
4788
|
arrappend: (key: string, path: string, ...values: unknown[]) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4276
4789
|
/**
|
|
4277
4790
|
* @see https://redis.io/commands/json.arrindex
|
|
4791
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrindex.mdx
|
|
4278
4792
|
*/
|
|
4279
4793
|
arrindex: (key: string, path: string, value: unknown, start?: number | undefined, stop?: number | undefined) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4280
4794
|
/**
|
|
4281
4795
|
* @see https://redis.io/commands/json.arrinsert
|
|
4796
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrinsert.mdx
|
|
4282
4797
|
*/
|
|
4283
4798
|
arrinsert: (key: string, path: string, index: number, ...values: unknown[]) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4284
4799
|
/**
|
|
4285
4800
|
* @see https://redis.io/commands/json.arrlen
|
|
4801
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrlen.mdx
|
|
4286
4802
|
*/
|
|
4287
4803
|
arrlen: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4288
4804
|
/**
|
|
4289
4805
|
* @see https://redis.io/commands/json.arrpop
|
|
4806
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrpop.mdx
|
|
4290
4807
|
*/
|
|
4291
4808
|
arrpop: (key: string, path?: string | undefined, index?: number | undefined) => Pipeline<[...TCommands, Command<any, unknown[]>]>;
|
|
4292
4809
|
/**
|
|
4293
4810
|
* @see https://redis.io/commands/json.arrtrim
|
|
4811
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrtrim.mdx
|
|
4294
4812
|
*/
|
|
4295
4813
|
arrtrim: (key: string, path?: string | undefined, start?: number | undefined, stop?: number | undefined) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4296
4814
|
/**
|
|
4297
4815
|
* @see https://redis.io/commands/json.clear
|
|
4816
|
+
* @see node_modules/@upstash/redis/docs/commands/json/clear.mdx
|
|
4298
4817
|
*/
|
|
4299
4818
|
clear: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4300
4819
|
/**
|
|
4301
4820
|
* @see https://redis.io/commands/json.del
|
|
4821
|
+
* @see node_modules/@upstash/redis/docs/commands/json/del.mdx
|
|
4302
4822
|
*/
|
|
4303
4823
|
del: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4304
4824
|
/**
|
|
4305
4825
|
* @see https://redis.io/commands/json.forget
|
|
4826
|
+
* @see node_modules/@upstash/redis/docs/commands/json/forget.mdx
|
|
4306
4827
|
*/
|
|
4307
4828
|
forget: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, number>]>;
|
|
4308
4829
|
/**
|
|
4309
4830
|
* @see https://redis.io/commands/json.get
|
|
4831
|
+
* @see node_modules/@upstash/redis/docs/commands/json/get.mdx
|
|
4310
4832
|
*/
|
|
4311
4833
|
get: (...args: CommandArgs<typeof JsonGetCommand>) => Pipeline<[...TCommands, Command<any, any>]>;
|
|
4312
4834
|
/**
|
|
4313
4835
|
* @see https://redis.io/commands/json.merge
|
|
4836
|
+
* @see node_modules/@upstash/redis/docs/commands/json/merge.mdx
|
|
4314
4837
|
*/
|
|
4315
4838
|
merge: (key: string, path: string, value: string | number | unknown[] | Record<string, unknown>) => Pipeline<[...TCommands, Command<any, "OK" | null>]>;
|
|
4316
4839
|
/**
|
|
4317
4840
|
* @see https://redis.io/commands/json.mget
|
|
4841
|
+
* @see node_modules/@upstash/redis/docs/commands/json/mget.mdx
|
|
4318
4842
|
*/
|
|
4319
4843
|
mget: (keys: string[], path: string) => Pipeline<[...TCommands, Command<any, any>]>;
|
|
4320
4844
|
/**
|
|
4321
4845
|
* @see https://redis.io/commands/json.mset
|
|
4846
|
+
* @see node_modules/@upstash/redis/docs/commands/json/mset.mdx
|
|
4322
4847
|
*/
|
|
4323
4848
|
mset: (...args: CommandArgs<typeof JsonMSetCommand>) => Pipeline<[...TCommands, Command<any, "OK" | null>]>;
|
|
4324
4849
|
/**
|
|
4325
4850
|
* @see https://redis.io/commands/json.numincrby
|
|
4851
|
+
* @see node_modules/@upstash/redis/docs/commands/json/numincrby.mdx
|
|
4326
4852
|
*/
|
|
4327
4853
|
numincrby: (key: string, path: string, value: number) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4328
4854
|
/**
|
|
4329
4855
|
* @see https://redis.io/commands/json.nummultby
|
|
4856
|
+
* @see node_modules/@upstash/redis/docs/commands/json/nummultby.mdx
|
|
4330
4857
|
*/
|
|
4331
4858
|
nummultby: (key: string, path: string, value: number) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4332
4859
|
/**
|
|
4333
4860
|
* @see https://redis.io/commands/json.objkeys
|
|
4861
|
+
* @see node_modules/@upstash/redis/docs/commands/json/objkeys.mdx
|
|
4334
4862
|
*/
|
|
4335
4863
|
objkeys: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, (string[] | null)[]>]>;
|
|
4336
4864
|
/**
|
|
4337
4865
|
* @see https://redis.io/commands/json.objlen
|
|
4866
|
+
* @see node_modules/@upstash/redis/docs/commands/json/objlen.mdx
|
|
4338
4867
|
*/
|
|
4339
4868
|
objlen: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4340
4869
|
/**
|
|
@@ -4343,6 +4872,7 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4343
4872
|
resp: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, any>]>;
|
|
4344
4873
|
/**
|
|
4345
4874
|
* @see https://redis.io/commands/json.set
|
|
4875
|
+
* @see node_modules/@upstash/redis/docs/commands/json/set.mdx
|
|
4346
4876
|
*/
|
|
4347
4877
|
set: (key: string, path: string, value: string | number | boolean | Record<string, unknown> | (string | number | boolean | Record<string, unknown>)[], opts?: {
|
|
4348
4878
|
nx: true;
|
|
@@ -4353,28 +4883,34 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4353
4883
|
} | undefined) => Pipeline<[...TCommands, Command<any, "OK" | null>]>;
|
|
4354
4884
|
/**
|
|
4355
4885
|
* @see https://redis.io/commands/json.strappend
|
|
4886
|
+
* @see node_modules/@upstash/redis/docs/commands/json/strappend.mdx
|
|
4356
4887
|
*/
|
|
4357
4888
|
strappend: (key: string, path: string, value: string) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4358
4889
|
/**
|
|
4359
4890
|
* @see https://redis.io/commands/json.strlen
|
|
4891
|
+
* @see node_modules/@upstash/redis/docs/commands/json/strlen.mdx
|
|
4360
4892
|
*/
|
|
4361
4893
|
strlen: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, (number | null)[]>]>;
|
|
4362
4894
|
/**
|
|
4363
4895
|
* @see https://redis.io/commands/json.toggle
|
|
4896
|
+
* @see node_modules/@upstash/redis/docs/commands/json/toggle.mdx
|
|
4364
4897
|
*/
|
|
4365
4898
|
toggle: (key: string, path: string) => Pipeline<[...TCommands, Command<any, number[]>]>;
|
|
4366
4899
|
/**
|
|
4367
4900
|
* @see https://redis.io/commands/json.type
|
|
4901
|
+
* @see node_modules/@upstash/redis/docs/commands/json/type.mdx
|
|
4368
4902
|
*/
|
|
4369
4903
|
type: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, string[]>]>;
|
|
4370
4904
|
};
|
|
4371
4905
|
get functions(): {
|
|
4372
4906
|
/**
|
|
4373
4907
|
* @see https://redis.io/docs/latest/commands/function-load/
|
|
4908
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/load.mdx
|
|
4374
4909
|
*/
|
|
4375
4910
|
load: (args: FunctionLoadArgs) => Pipeline<[...TCommands, Command<any, string>]>;
|
|
4376
4911
|
/**
|
|
4377
4912
|
* @see https://redis.io/docs/latest/commands/function-list/
|
|
4913
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/list.mdx
|
|
4378
4914
|
*/
|
|
4379
4915
|
list: (args?: FunctionListArgs | undefined) => Pipeline<[...TCommands, Command<any, {
|
|
4380
4916
|
libraryName: string;
|
|
@@ -4388,14 +4924,17 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4388
4924
|
}[]>]>;
|
|
4389
4925
|
/**
|
|
4390
4926
|
* @see https://redis.io/docs/latest/commands/function-delete/
|
|
4927
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/delete.mdx
|
|
4391
4928
|
*/
|
|
4392
4929
|
delete: (libraryName: string) => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
4393
4930
|
/**
|
|
4394
4931
|
* @see https://redis.io/docs/latest/commands/function-flush/
|
|
4932
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/flush.mdx
|
|
4395
4933
|
*/
|
|
4396
4934
|
flush: () => Pipeline<[...TCommands, Command<any, "OK">]>;
|
|
4397
4935
|
/**
|
|
4398
4936
|
* @see https://redis.io/docs/latest/commands/function-stats/
|
|
4937
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/stats.mdx
|
|
4399
4938
|
*/
|
|
4400
4939
|
stats: () => Pipeline<[...TCommands, Command<any, {
|
|
4401
4940
|
engines: {
|
|
@@ -4407,10 +4946,12 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4407
4946
|
}>]>;
|
|
4408
4947
|
/**
|
|
4409
4948
|
* @see https://redis.io/docs/latest/commands/fcall/
|
|
4949
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/call.mdx
|
|
4410
4950
|
*/
|
|
4411
4951
|
call: <TData = unknown>(functionName: string, keys?: string[] | undefined, args?: string[] | undefined) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
4412
4952
|
/**
|
|
4413
4953
|
* @see https://redis.io/docs/latest/commands/fcall_ro/
|
|
4954
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/call_ro.mdx
|
|
4414
4955
|
*/
|
|
4415
4956
|
callRo: <TData = unknown>(functionName: string, keys?: string[] | undefined, args?: string[] | undefined) => Pipeline<[...TCommands, Command<any, TData>]>;
|
|
4416
4957
|
};
|
|
@@ -4423,6 +4964,10 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
|
|
|
4423
4964
|
* entire script to the server. If the script is loaded on the server, it tries again by sending
|
|
4424
4965
|
* the entire script. Afterwards, the script is cached on the server.
|
|
4425
4966
|
*
|
|
4967
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
4968
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
4969
|
+
* to receive raw strings.
|
|
4970
|
+
*
|
|
4426
4971
|
* @example
|
|
4427
4972
|
* ```ts
|
|
4428
4973
|
* const redis = new Redis({...})
|
|
@@ -4477,6 +5022,10 @@ declare class Script<TResult = unknown> {
|
|
|
4477
5022
|
* entire script to the server. If the script is loaded on the server, it tries again by sending
|
|
4478
5023
|
* the entire script. Afterwards, the script is cached on the server.
|
|
4479
5024
|
*
|
|
5025
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5026
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5027
|
+
* to receive raw strings.
|
|
5028
|
+
*
|
|
4480
5029
|
* @example
|
|
4481
5030
|
* ```ts
|
|
4482
5031
|
* const redis = new Redis({...})
|
|
@@ -4546,70 +5095,87 @@ declare class Redis {
|
|
|
4546
5095
|
get json(): {
|
|
4547
5096
|
/**
|
|
4548
5097
|
* @see https://redis.io/commands/json.arrappend
|
|
5098
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrappend.mdx
|
|
4549
5099
|
*/
|
|
4550
5100
|
arrappend: (key: string, path: string, ...values: unknown[]) => Promise<(number | null)[]>;
|
|
4551
5101
|
/**
|
|
4552
5102
|
* @see https://redis.io/commands/json.arrindex
|
|
5103
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrindex.mdx
|
|
4553
5104
|
*/
|
|
4554
5105
|
arrindex: (key: string, path: string, value: unknown, start?: number | undefined, stop?: number | undefined) => Promise<(number | null)[]>;
|
|
4555
5106
|
/**
|
|
4556
5107
|
* @see https://redis.io/commands/json.arrinsert
|
|
5108
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrinsert.mdx
|
|
4557
5109
|
*/
|
|
4558
5110
|
arrinsert: (key: string, path: string, index: number, ...values: unknown[]) => Promise<(number | null)[]>;
|
|
4559
5111
|
/**
|
|
4560
5112
|
* @see https://redis.io/commands/json.arrlen
|
|
5113
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrlen.mdx
|
|
4561
5114
|
*/
|
|
4562
5115
|
arrlen: (key: string, path?: string | undefined) => Promise<(number | null)[]>;
|
|
4563
5116
|
/**
|
|
4564
5117
|
* @see https://redis.io/commands/json.arrpop
|
|
5118
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrpop.mdx
|
|
4565
5119
|
*/
|
|
4566
5120
|
arrpop: (key: string, path?: string | undefined, index?: number | undefined) => Promise<unknown[]>;
|
|
4567
5121
|
/**
|
|
4568
5122
|
* @see https://redis.io/commands/json.arrtrim
|
|
5123
|
+
* @see node_modules/@upstash/redis/docs/commands/json/arrtrim.mdx
|
|
4569
5124
|
*/
|
|
4570
5125
|
arrtrim: (key: string, path?: string | undefined, start?: number | undefined, stop?: number | undefined) => Promise<(number | null)[]>;
|
|
4571
5126
|
/**
|
|
4572
5127
|
* @see https://redis.io/commands/json.clear
|
|
5128
|
+
* @see node_modules/@upstash/redis/docs/commands/json/clear.mdx
|
|
4573
5129
|
*/
|
|
4574
5130
|
clear: (key: string, path?: string | undefined) => Promise<number>;
|
|
4575
5131
|
/**
|
|
4576
5132
|
* @see https://redis.io/commands/json.del
|
|
5133
|
+
* @see node_modules/@upstash/redis/docs/commands/json/del.mdx
|
|
4577
5134
|
*/
|
|
4578
5135
|
del: (key: string, path?: string | undefined) => Promise<number>;
|
|
4579
5136
|
/**
|
|
4580
5137
|
* @see https://redis.io/commands/json.forget
|
|
5138
|
+
* @see node_modules/@upstash/redis/docs/commands/json/forget.mdx
|
|
4581
5139
|
*/
|
|
4582
5140
|
forget: (key: string, path?: string | undefined) => Promise<number>;
|
|
4583
5141
|
/**
|
|
4584
5142
|
* @see https://redis.io/commands/json.get
|
|
5143
|
+
* @see node_modules/@upstash/redis/docs/commands/json/get.mdx
|
|
4585
5144
|
*/
|
|
4586
5145
|
get: <TData>(...args: CommandArgs<typeof JsonGetCommand>) => Promise<TData | null>;
|
|
4587
5146
|
/**
|
|
4588
5147
|
* @see https://redis.io/commands/json.merge
|
|
5148
|
+
* @see node_modules/@upstash/redis/docs/commands/json/merge.mdx
|
|
4589
5149
|
*/
|
|
4590
5150
|
merge: (key: string, path: string, value: string | number | unknown[] | Record<string, unknown>) => Promise<"OK" | null>;
|
|
4591
5151
|
/**
|
|
4592
5152
|
* @see https://redis.io/commands/json.mget
|
|
5153
|
+
* @see node_modules/@upstash/redis/docs/commands/json/mget.mdx
|
|
4593
5154
|
*/
|
|
4594
5155
|
mget: <TData>(keys: string[], path: string) => Promise<TData>;
|
|
4595
5156
|
/**
|
|
4596
5157
|
* @see https://redis.io/commands/json.mset
|
|
5158
|
+
* @see node_modules/@upstash/redis/docs/commands/json/mset.mdx
|
|
4597
5159
|
*/
|
|
4598
5160
|
mset: (...args: CommandArgs<typeof JsonMSetCommand>) => Promise<"OK" | null>;
|
|
4599
5161
|
/**
|
|
4600
5162
|
* @see https://redis.io/commands/json.numincrby
|
|
5163
|
+
* @see node_modules/@upstash/redis/docs/commands/json/numincrby.mdx
|
|
4601
5164
|
*/
|
|
4602
5165
|
numincrby: (key: string, path: string, value: number) => Promise<(number | null)[]>;
|
|
4603
5166
|
/**
|
|
4604
5167
|
* @see https://redis.io/commands/json.nummultby
|
|
5168
|
+
* @see node_modules/@upstash/redis/docs/commands/json/nummultby.mdx
|
|
4605
5169
|
*/
|
|
4606
5170
|
nummultby: (key: string, path: string, value: number) => Promise<(number | null)[]>;
|
|
4607
5171
|
/**
|
|
4608
5172
|
* @see https://redis.io/commands/json.objkeys
|
|
5173
|
+
* @see node_modules/@upstash/redis/docs/commands/json/objkeys.mdx
|
|
4609
5174
|
*/
|
|
4610
5175
|
objkeys: (key: string, path?: string | undefined) => Promise<(string[] | null)[]>;
|
|
4611
5176
|
/**
|
|
4612
5177
|
* @see https://redis.io/commands/json.objlen
|
|
5178
|
+
* @see node_modules/@upstash/redis/docs/commands/json/objlen.mdx
|
|
4613
5179
|
*/
|
|
4614
5180
|
objlen: (key: string, path?: string | undefined) => Promise<(number | null)[]>;
|
|
4615
5181
|
/**
|
|
@@ -4618,6 +5184,7 @@ declare class Redis {
|
|
|
4618
5184
|
resp: (key: string, path?: string | undefined) => Promise<any>;
|
|
4619
5185
|
/**
|
|
4620
5186
|
* @see https://redis.io/commands/json.set
|
|
5187
|
+
* @see node_modules/@upstash/redis/docs/commands/json/set.mdx
|
|
4621
5188
|
*/
|
|
4622
5189
|
set: (key: string, path: string, value: string | number | boolean | Record<string, unknown> | (string | number | boolean | Record<string, unknown>)[], opts?: {
|
|
4623
5190
|
nx: true;
|
|
@@ -4628,28 +5195,34 @@ declare class Redis {
|
|
|
4628
5195
|
} | undefined) => Promise<"OK" | null>;
|
|
4629
5196
|
/**
|
|
4630
5197
|
* @see https://redis.io/commands/json.strappend
|
|
5198
|
+
* @see node_modules/@upstash/redis/docs/commands/json/strappend.mdx
|
|
4631
5199
|
*/
|
|
4632
5200
|
strappend: (key: string, path: string, value: string) => Promise<(number | null)[]>;
|
|
4633
5201
|
/**
|
|
4634
5202
|
* @see https://redis.io/commands/json.strlen
|
|
5203
|
+
* @see node_modules/@upstash/redis/docs/commands/json/strlen.mdx
|
|
4635
5204
|
*/
|
|
4636
5205
|
strlen: (key: string, path?: string | undefined) => Promise<(number | null)[]>;
|
|
4637
5206
|
/**
|
|
4638
5207
|
* @see https://redis.io/commands/json.toggle
|
|
5208
|
+
* @see node_modules/@upstash/redis/docs/commands/json/toggle.mdx
|
|
4639
5209
|
*/
|
|
4640
5210
|
toggle: (key: string, path: string) => Promise<number[]>;
|
|
4641
5211
|
/**
|
|
4642
5212
|
* @see https://redis.io/commands/json.type
|
|
5213
|
+
* @see node_modules/@upstash/redis/docs/commands/json/type.mdx
|
|
4643
5214
|
*/
|
|
4644
5215
|
type: (key: string, path?: string | undefined) => Promise<string[]>;
|
|
4645
5216
|
};
|
|
4646
5217
|
get functions(): {
|
|
4647
5218
|
/**
|
|
4648
5219
|
* @see https://redis.io/docs/latest/commands/function-load/
|
|
5220
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/load.mdx
|
|
4649
5221
|
*/
|
|
4650
5222
|
load: (args: FunctionLoadArgs) => Promise<string>;
|
|
4651
5223
|
/**
|
|
4652
5224
|
* @see https://redis.io/docs/latest/commands/function-list/
|
|
5225
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/list.mdx
|
|
4653
5226
|
*/
|
|
4654
5227
|
list: (args?: FunctionListArgs | undefined) => Promise<{
|
|
4655
5228
|
libraryName: string;
|
|
@@ -4663,14 +5236,17 @@ declare class Redis {
|
|
|
4663
5236
|
}[]>;
|
|
4664
5237
|
/**
|
|
4665
5238
|
* @see https://redis.io/docs/latest/commands/function-delete/
|
|
5239
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/delete.mdx
|
|
4666
5240
|
*/
|
|
4667
5241
|
delete: (libraryName: string) => Promise<"OK">;
|
|
4668
5242
|
/**
|
|
4669
5243
|
* @see https://redis.io/docs/latest/commands/function-flush/
|
|
5244
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/flush.mdx
|
|
4670
5245
|
*/
|
|
4671
5246
|
flush: () => Promise<"OK">;
|
|
4672
5247
|
/**
|
|
4673
5248
|
* @see https://redis.io/docs/latest/commands/function-stats/
|
|
5249
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/stats.mdx
|
|
4674
5250
|
*
|
|
4675
5251
|
* Note: `running_script` field is not supported and therefore not included in the type.
|
|
4676
5252
|
*/
|
|
@@ -4684,10 +5260,12 @@ declare class Redis {
|
|
|
4684
5260
|
}>;
|
|
4685
5261
|
/**
|
|
4686
5262
|
* @see https://redis.io/docs/latest/commands/fcall/
|
|
5263
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/call.mdx
|
|
4687
5264
|
*/
|
|
4688
5265
|
call: <TData = unknown>(functionName: string, keys?: string[] | undefined, args?: string[] | undefined) => Promise<TData>;
|
|
4689
5266
|
/**
|
|
4690
5267
|
* @see https://redis.io/docs/latest/commands/fcall_ro/
|
|
5268
|
+
* @see node_modules/@upstash/redis/docs/commands/functions/call_ro.mdx
|
|
4691
5269
|
*/
|
|
4692
5270
|
callRo: <TData = unknown>(functionName: string, keys?: string[] | undefined, args?: string[] | undefined) => Promise<TData>;
|
|
4693
5271
|
};
|
|
@@ -4706,6 +5284,10 @@ declare class Redis {
|
|
|
4706
5284
|
* entire script to the server. If the script is loaded on the server, it tries again by sending
|
|
4707
5285
|
* the entire script. Afterwards, the script is cached on the server.
|
|
4708
5286
|
*
|
|
5287
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5288
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5289
|
+
* to receive raw strings.
|
|
5290
|
+
*
|
|
4709
5291
|
* @param script - The script to create
|
|
4710
5292
|
* @param opts - Optional options to pass to the script `{ readonly?: boolean }`
|
|
4711
5293
|
* @returns A new script
|
|
@@ -4799,86 +5381,107 @@ declare class Redis {
|
|
|
4799
5381
|
bitfield: (...args: CommandArgs<typeof BitFieldCommand>) => BitFieldCommand<Promise<number[]>>;
|
|
4800
5382
|
/**
|
|
4801
5383
|
* @see https://redis.io/commands/append
|
|
5384
|
+
* @see node_modules/@upstash/redis/docs/commands/string/append.mdx
|
|
4802
5385
|
*/
|
|
4803
5386
|
append: (...args: CommandArgs<typeof AppendCommand>) => Promise<number>;
|
|
4804
5387
|
/**
|
|
4805
5388
|
* @see https://upstash.com/docs/redis/commands/array/arcount
|
|
5389
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arcount.mdx
|
|
4806
5390
|
*/
|
|
4807
5391
|
arcount: (...args: CommandArgs<typeof ArCountCommand>) => Promise<number>;
|
|
4808
5392
|
/**
|
|
4809
5393
|
* @see https://upstash.com/docs/redis/commands/array/ardel
|
|
5394
|
+
* @see node_modules/@upstash/redis/docs/commands/array/ardel.mdx
|
|
4810
5395
|
*/
|
|
4811
5396
|
ardel: (...args: CommandArgs<typeof ArDelCommand>) => Promise<number>;
|
|
4812
5397
|
/**
|
|
4813
5398
|
* @see https://upstash.com/docs/redis/commands/array/ardelrange
|
|
5399
|
+
* @see node_modules/@upstash/redis/docs/commands/array/ardelrange.mdx
|
|
4814
5400
|
*/
|
|
4815
5401
|
ardelrange: (...args: CommandArgs<typeof ArDelRangeCommand>) => Promise<number>;
|
|
4816
5402
|
/**
|
|
4817
5403
|
* @see https://upstash.com/docs/redis/commands/array/arget
|
|
5404
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arget.mdx
|
|
4818
5405
|
*/
|
|
4819
5406
|
arget: <TData = string>(...args: CommandArgs<typeof ArGetCommand>) => Promise<TData | null>;
|
|
4820
5407
|
/**
|
|
4821
5408
|
* @see https://upstash.com/docs/redis/commands/array/argetrange
|
|
5409
|
+
* @see node_modules/@upstash/redis/docs/commands/array/argetrange.mdx
|
|
4822
5410
|
*/
|
|
4823
5411
|
argetrange: <TData = string>(...args: CommandArgs<typeof ArGetRangeCommand>) => Promise<(TData | null)[]>;
|
|
4824
5412
|
/**
|
|
4825
5413
|
* @see https://upstash.com/docs/redis/commands/array/argrep
|
|
5414
|
+
* @see node_modules/@upstash/redis/docs/commands/array/argrep.mdx
|
|
4826
5415
|
*/
|
|
4827
5416
|
argrep: <TData = string, TOpts extends ArGrepOptions = ArGrepOptions>(key: string, start: number | string, end: number | string, opts: TOpts) => Promise<ArGrepResult<TData, TOpts>>;
|
|
4828
5417
|
/**
|
|
4829
5418
|
* @see https://upstash.com/docs/redis/commands/array/arinfo
|
|
5419
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arinfo.mdx
|
|
4830
5420
|
*/
|
|
4831
5421
|
arinfo: (...args: CommandArgs<typeof ArInfoCommand>) => Promise<ArInfoResult>;
|
|
4832
5422
|
/**
|
|
4833
5423
|
* @see https://upstash.com/docs/redis/commands/array/arinsert
|
|
5424
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arinsert.mdx
|
|
4834
5425
|
*/
|
|
4835
5426
|
arinsert: <TData>(key: string, ...values: TData[]) => Promise<string>;
|
|
4836
5427
|
/**
|
|
4837
5428
|
* @see https://upstash.com/docs/redis/commands/array/arlastitems
|
|
5429
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arlastitems.mdx
|
|
4838
5430
|
*/
|
|
4839
5431
|
arlastitems: <TData = string>(...args: CommandArgs<typeof ArLastItemsCommand>) => Promise<(TData | null)[]>;
|
|
4840
5432
|
/**
|
|
4841
5433
|
* @see https://upstash.com/docs/redis/commands/array/arlen
|
|
5434
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arlen.mdx
|
|
4842
5435
|
*/
|
|
4843
5436
|
arlen: (...args: CommandArgs<typeof ArLenCommand>) => Promise<string>;
|
|
4844
5437
|
/**
|
|
4845
5438
|
* @see https://upstash.com/docs/redis/commands/array/armget
|
|
5439
|
+
* @see node_modules/@upstash/redis/docs/commands/array/armget.mdx
|
|
4846
5440
|
*/
|
|
4847
5441
|
armget: <TData = string>(...args: CommandArgs<typeof ArMGetCommand>) => Promise<(TData | null)[]>;
|
|
4848
5442
|
/**
|
|
4849
5443
|
* @see https://upstash.com/docs/redis/commands/array/armset
|
|
5444
|
+
* @see node_modules/@upstash/redis/docs/commands/array/armset.mdx
|
|
4850
5445
|
*/
|
|
4851
5446
|
armset: <TData>(key: string, values: ArMSetValues<TData>) => Promise<number>;
|
|
4852
5447
|
/**
|
|
4853
5448
|
* @see https://upstash.com/docs/redis/commands/array/arnext
|
|
5449
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arnext.mdx
|
|
4854
5450
|
*/
|
|
4855
5451
|
arnext: (...args: CommandArgs<typeof ArNextCommand>) => Promise<string | null>;
|
|
4856
5452
|
/**
|
|
4857
5453
|
* @see https://upstash.com/docs/redis/commands/array/arop
|
|
5454
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arop.mdx
|
|
4858
5455
|
*/
|
|
4859
5456
|
arop: <TData = string>(key: string, start: number | string, end: number | string, operation: ArOpOperation<TData>) => Promise<number | null>;
|
|
4860
5457
|
/**
|
|
4861
5458
|
* @see https://upstash.com/docs/redis/commands/array/arring
|
|
5459
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arring.mdx
|
|
4862
5460
|
*/
|
|
4863
5461
|
arring: <TData>(key: string, size: number, ...values: TData[]) => Promise<string>;
|
|
4864
5462
|
/**
|
|
4865
5463
|
* @see https://upstash.com/docs/redis/commands/array/arscan
|
|
5464
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arscan.mdx
|
|
4866
5465
|
*/
|
|
4867
5466
|
arscan: <TData = string>(...args: CommandArgs<typeof ArScanCommand>) => Promise<[string, TData][]>;
|
|
4868
5467
|
/**
|
|
4869
5468
|
* @see https://upstash.com/docs/redis/commands/array/arseek
|
|
5469
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arseek.mdx
|
|
4870
5470
|
*/
|
|
4871
5471
|
arseek: (...args: CommandArgs<typeof ArSeekCommand>) => Promise<0 | 1>;
|
|
4872
5472
|
/**
|
|
4873
5473
|
* @see https://upstash.com/docs/redis/commands/array/arset
|
|
5474
|
+
* @see node_modules/@upstash/redis/docs/commands/array/arset.mdx
|
|
4874
5475
|
*/
|
|
4875
5476
|
arset: <TData>(key: string, index: number | string, ...values: TData[]) => Promise<number>;
|
|
4876
5477
|
/**
|
|
4877
5478
|
* @see https://redis.io/commands/bitcount
|
|
5479
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitcount.mdx
|
|
4878
5480
|
*/
|
|
4879
5481
|
bitcount: (...args: CommandArgs<typeof BitCountCommand>) => Promise<number>;
|
|
4880
5482
|
/**
|
|
4881
5483
|
* @see https://redis.io/commands/bitop
|
|
5484
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitop.mdx
|
|
4882
5485
|
*/
|
|
4883
5486
|
bitop: {
|
|
4884
5487
|
(op: "and" | "or" | "xor", destinationKey: string, sourceKey: string, ...sourceKeys: string[]): Promise<number>;
|
|
@@ -4888,10 +5491,12 @@ declare class Redis {
|
|
|
4888
5491
|
};
|
|
4889
5492
|
/**
|
|
4890
5493
|
* @see https://redis.io/commands/bitpos
|
|
5494
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/bitpos.mdx
|
|
4891
5495
|
*/
|
|
4892
5496
|
bitpos: (...args: CommandArgs<typeof BitPosCommand>) => Promise<number>;
|
|
4893
5497
|
/**
|
|
4894
5498
|
* @see https://redis.io/commands/client-setinfo
|
|
5499
|
+
* @see node_modules/@upstash/redis/docs/commands/connection/client_setinfo.mdx
|
|
4895
5500
|
*/
|
|
4896
5501
|
clientSetinfo: (...args: CommandArgs<typeof ClientSetInfoCommand>) => Promise<string>;
|
|
4897
5502
|
/**
|
|
@@ -4900,38 +5505,59 @@ declare class Redis {
|
|
|
4900
5505
|
copy: (...args: CommandArgs<typeof CopyCommand>) => Promise<"COPIED" | "NOT_COPIED">;
|
|
4901
5506
|
/**
|
|
4902
5507
|
* @see https://redis.io/commands/dbsize
|
|
5508
|
+
* @see node_modules/@upstash/redis/docs/commands/server/dbsize.mdx
|
|
4903
5509
|
*/
|
|
4904
5510
|
dbsize: () => Promise<number>;
|
|
4905
5511
|
/**
|
|
4906
5512
|
* @see https://redis.io/commands/decr
|
|
5513
|
+
* @see node_modules/@upstash/redis/docs/commands/string/decr.mdx
|
|
4907
5514
|
*/
|
|
4908
5515
|
decr: (...args: CommandArgs<typeof DecrCommand>) => Promise<number>;
|
|
4909
5516
|
/**
|
|
4910
5517
|
* @see https://redis.io/commands/decrby
|
|
5518
|
+
* @see node_modules/@upstash/redis/docs/commands/string/decrby.mdx
|
|
4911
5519
|
*/
|
|
4912
5520
|
decrby: (...args: CommandArgs<typeof DecrByCommand>) => Promise<number>;
|
|
4913
5521
|
/**
|
|
4914
5522
|
* @see https://redis.io/commands/del
|
|
5523
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/del.mdx
|
|
4915
5524
|
*/
|
|
4916
5525
|
del: (...args: CommandArgs<typeof DelCommand>) => Promise<number>;
|
|
4917
5526
|
/**
|
|
4918
5527
|
* @see https://redis.io/commands/echo
|
|
5528
|
+
* @see node_modules/@upstash/redis/docs/commands/auth/echo.mdx
|
|
4919
5529
|
*/
|
|
4920
5530
|
echo: (...args: CommandArgs<typeof EchoCommand>) => Promise<string>;
|
|
4921
5531
|
/**
|
|
4922
5532
|
* @see https://redis.io/commands/eval_ro
|
|
5533
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/eval_ro.mdx
|
|
5534
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5535
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5536
|
+
* to receive raw strings.
|
|
4923
5537
|
*/
|
|
4924
5538
|
evalRo: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Promise<TData>;
|
|
4925
5539
|
/**
|
|
4926
5540
|
* @see https://redis.io/commands/eval
|
|
5541
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/eval.mdx
|
|
5542
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5543
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5544
|
+
* to receive raw strings.
|
|
4927
5545
|
*/
|
|
4928
5546
|
eval: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Promise<TData>;
|
|
4929
5547
|
/**
|
|
4930
5548
|
* @see https://redis.io/commands/evalsha_ro
|
|
5549
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/evalsha_ro.mdx
|
|
5550
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5551
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5552
|
+
* to receive raw strings.
|
|
4931
5553
|
*/
|
|
4932
5554
|
evalshaRo: <TArgs extends unknown[], TData = unknown>(...args: [sha1: string, keys: string[], args: TArgs]) => Promise<TData>;
|
|
4933
5555
|
/**
|
|
4934
5556
|
* @see https://redis.io/commands/evalsha
|
|
5557
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/evalsha.mdx
|
|
5558
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5559
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5560
|
+
* to receive raw strings.
|
|
4935
5561
|
*/
|
|
4936
5562
|
evalsha: <TArgs extends unknown[], TData = unknown>(...args: [sha1: string, keys: string[], args: TArgs]) => Promise<TData>;
|
|
4937
5563
|
/**
|
|
@@ -4940,22 +5566,27 @@ declare class Redis {
|
|
|
4940
5566
|
exec: <TResult>(args: [command: string, ...args: (string | number | boolean)[]]) => Promise<TResult>;
|
|
4941
5567
|
/**
|
|
4942
5568
|
* @see https://redis.io/commands/exists
|
|
5569
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/exists.mdx
|
|
4943
5570
|
*/
|
|
4944
5571
|
exists: (...args: CommandArgs<typeof ExistsCommand>) => Promise<number>;
|
|
4945
5572
|
/**
|
|
4946
5573
|
* @see https://redis.io/commands/expire
|
|
5574
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/expire.mdx
|
|
4947
5575
|
*/
|
|
4948
5576
|
expire: (...args: CommandArgs<typeof ExpireCommand>) => Promise<0 | 1>;
|
|
4949
5577
|
/**
|
|
4950
5578
|
* @see https://redis.io/commands/expireat
|
|
5579
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/expireat.mdx
|
|
4951
5580
|
*/
|
|
4952
5581
|
expireat: (...args: CommandArgs<typeof ExpireAtCommand>) => Promise<0 | 1>;
|
|
4953
5582
|
/**
|
|
4954
5583
|
* @see https://redis.io/commands/flushall
|
|
5584
|
+
* @see node_modules/@upstash/redis/docs/commands/server/flushall.mdx
|
|
4955
5585
|
*/
|
|
4956
5586
|
flushall: (args?: CommandArgs<typeof FlushAllCommand>) => Promise<"OK">;
|
|
4957
5587
|
/**
|
|
4958
5588
|
* @see https://redis.io/commands/flushdb
|
|
5589
|
+
* @see node_modules/@upstash/redis/docs/commands/server/flushdb.mdx
|
|
4959
5590
|
*/
|
|
4960
5591
|
flushdb: (...args: CommandArgs<typeof FlushDBCommand>) => Promise<"OK">;
|
|
4961
5592
|
/**
|
|
@@ -4996,106 +5627,166 @@ declare class Redis {
|
|
|
4996
5627
|
geosearchstore: <TData>(...args: CommandArgs<typeof GeoSearchStoreCommand<TData>>) => Promise<number>;
|
|
4997
5628
|
/**
|
|
4998
5629
|
* @see https://redis.io/commands/get
|
|
5630
|
+
* @see node_modules/@upstash/redis/docs/commands/string/get.mdx
|
|
5631
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5632
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5633
|
+
* to receive raw strings.
|
|
4999
5634
|
*/
|
|
5000
5635
|
get: <TData>(...args: CommandArgs<typeof GetCommand>) => Promise<TData | null>;
|
|
5001
5636
|
/**
|
|
5002
5637
|
* @see https://redis.io/commands/getbit
|
|
5638
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/getbit.mdx
|
|
5003
5639
|
*/
|
|
5004
5640
|
getbit: (...args: CommandArgs<typeof GetBitCommand>) => Promise<0 | 1>;
|
|
5005
5641
|
/**
|
|
5006
5642
|
* @see https://redis.io/commands/getdel
|
|
5643
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getdel.mdx
|
|
5644
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5645
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5646
|
+
* to receive raw strings.
|
|
5007
5647
|
*/
|
|
5008
5648
|
getdel: <TData>(...args: CommandArgs<typeof GetDelCommand>) => Promise<TData | null>;
|
|
5009
5649
|
/**
|
|
5010
5650
|
* @see https://redis.io/commands/getex
|
|
5651
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5652
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5653
|
+
* to receive raw strings.
|
|
5011
5654
|
*/
|
|
5012
5655
|
getex: <TData>(...args: CommandArgs<typeof GetExCommand>) => Promise<TData | null>;
|
|
5013
5656
|
/**
|
|
5014
5657
|
* @see https://redis.io/commands/getrange
|
|
5658
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getrange.mdx
|
|
5015
5659
|
*/
|
|
5016
5660
|
getrange: (...args: CommandArgs<typeof GetRangeCommand>) => Promise<string>;
|
|
5017
5661
|
/**
|
|
5018
5662
|
* @see https://redis.io/commands/getset
|
|
5663
|
+
* @see node_modules/@upstash/redis/docs/commands/string/getset.mdx
|
|
5664
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5665
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5666
|
+
* to receive raw strings.
|
|
5019
5667
|
*/
|
|
5020
5668
|
getset: <TData>(key: string, value: TData) => Promise<TData | null>;
|
|
5021
5669
|
/**
|
|
5022
5670
|
* @see https://redis.io/commands/hdel
|
|
5671
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hdel.mdx
|
|
5023
5672
|
*/
|
|
5024
5673
|
hdel: (...args: CommandArgs<typeof HDelCommand>) => Promise<0 | 1>;
|
|
5025
5674
|
/**
|
|
5026
5675
|
* @see https://redis.io/commands/hexists
|
|
5676
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexists.mdx
|
|
5027
5677
|
*/
|
|
5028
5678
|
hexists: (...args: CommandArgs<typeof HExistsCommand>) => Promise<number>;
|
|
5029
5679
|
/**
|
|
5030
5680
|
* @see https://redis.io/commands/hexpire
|
|
5681
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexpire.mdx
|
|
5031
5682
|
*/
|
|
5032
5683
|
hexpire: (...args: CommandArgs<typeof HExpireCommand>) => Promise<(0 | 1 | 2 | -2)[]>;
|
|
5033
5684
|
/**
|
|
5034
5685
|
* @see https://redis.io/commands/hexpireat
|
|
5686
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexpireat.mdx
|
|
5035
5687
|
*/
|
|
5036
5688
|
hexpireat: (...args: CommandArgs<typeof HExpireAtCommand>) => Promise<(0 | 1 | 2 | -2)[]>;
|
|
5037
5689
|
/**
|
|
5038
5690
|
* @see https://redis.io/commands/hexpiretime
|
|
5691
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hexpiretime.mdx
|
|
5039
5692
|
*/
|
|
5040
5693
|
hexpiretime: (...args: CommandArgs<typeof HExpireTimeCommand>) => Promise<number[]>;
|
|
5041
5694
|
/**
|
|
5042
5695
|
* @see https://redis.io/commands/httl
|
|
5696
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/httl.mdx
|
|
5043
5697
|
*/
|
|
5044
5698
|
httl: (...args: CommandArgs<typeof HTtlCommand>) => Promise<number[]>;
|
|
5045
5699
|
/**
|
|
5046
5700
|
* @see https://redis.io/commands/hpexpire
|
|
5701
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpexpire.mdx
|
|
5047
5702
|
*/
|
|
5048
5703
|
hpexpire: (...args: CommandArgs<typeof HPExpireCommand>) => Promise<(0 | 1 | 2 | -2)[]>;
|
|
5049
5704
|
/**
|
|
5050
5705
|
* @see https://redis.io/commands/hpexpireat
|
|
5706
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpexpireat.mdx
|
|
5051
5707
|
*/
|
|
5052
5708
|
hpexpireat: (...args: CommandArgs<typeof HPExpireAtCommand>) => Promise<(0 | 1 | 2 | -2)[]>;
|
|
5053
5709
|
/**
|
|
5054
5710
|
* @see https://redis.io/commands/hpexpiretime
|
|
5711
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpexpiretime.mdx
|
|
5055
5712
|
*/
|
|
5056
5713
|
hpexpiretime: (...args: CommandArgs<typeof HPExpireTimeCommand>) => Promise<number[]>;
|
|
5057
5714
|
/**
|
|
5058
5715
|
* @see https://redis.io/commands/hpttl
|
|
5716
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpttl.mdx
|
|
5059
5717
|
*/
|
|
5060
5718
|
hpttl: (...args: CommandArgs<typeof HPTtlCommand>) => Promise<number[]>;
|
|
5061
5719
|
/**
|
|
5062
5720
|
* @see https://redis.io/commands/hpersist
|
|
5721
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hpersist.mdx
|
|
5063
5722
|
*/
|
|
5064
5723
|
hpersist: (...args: CommandArgs<typeof HPersistCommand>) => Promise<(1 | -2 | -1)[]>;
|
|
5065
5724
|
/**
|
|
5066
5725
|
* @see https://redis.io/commands/hget
|
|
5726
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hget.mdx
|
|
5727
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5728
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5729
|
+
* to receive raw strings.
|
|
5067
5730
|
*/
|
|
5068
5731
|
hget: <TData>(...args: CommandArgs<typeof HGetCommand>) => Promise<TData | null>;
|
|
5069
5732
|
/**
|
|
5070
5733
|
* @see https://redis.io/commands/hgetall
|
|
5734
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetall.mdx
|
|
5735
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5736
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5737
|
+
* to receive raw strings.
|
|
5738
|
+
* With automaticDeserialization: false, hgetall returns a flat array instead, such as
|
|
5739
|
+
* ["text", "123", "version", "1"], and [] for a missing key.
|
|
5071
5740
|
*/
|
|
5072
5741
|
hgetall: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HGetAllCommand>) => Promise<TData | null>;
|
|
5073
5742
|
/**
|
|
5074
5743
|
* @see https://redis.io/commands/hgetdel
|
|
5744
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetdel.mdx
|
|
5745
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5746
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5747
|
+
* to receive raw strings.
|
|
5748
|
+
* With automaticDeserialization: false, hgetdel returns an array of values in field order instead,
|
|
5749
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
5075
5750
|
*/
|
|
5076
5751
|
hgetdel: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HGetDelCommand>) => Promise<TData | null>;
|
|
5077
5752
|
/**
|
|
5078
5753
|
* @see https://redis.io/commands/hgetex
|
|
5754
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hgetex.mdx
|
|
5755
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5756
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5757
|
+
* to receive raw strings.
|
|
5758
|
+
* With automaticDeserialization: false, hgetex returns an array of values in field order instead,
|
|
5759
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
5079
5760
|
*/
|
|
5080
5761
|
hgetex: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HGetExCommand>) => Promise<TData | null>;
|
|
5081
5762
|
/**
|
|
5082
5763
|
* @see https://redis.io/commands/hincrby
|
|
5764
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hincrby.mdx
|
|
5083
5765
|
*/
|
|
5084
5766
|
hincrby: (...args: CommandArgs<typeof HIncrByCommand>) => Promise<number>;
|
|
5085
5767
|
/**
|
|
5086
5768
|
* @see https://redis.io/commands/hincrbyfloat
|
|
5769
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hincrbyfloat.mdx
|
|
5087
5770
|
*/
|
|
5088
5771
|
hincrbyfloat: (...args: CommandArgs<typeof HIncrByFloatCommand>) => Promise<number>;
|
|
5089
5772
|
/**
|
|
5090
5773
|
* @see https://redis.io/commands/hkeys
|
|
5774
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hkeys.mdx
|
|
5091
5775
|
*/
|
|
5092
5776
|
hkeys: (...args: CommandArgs<typeof HKeysCommand>) => Promise<string[]>;
|
|
5093
5777
|
/**
|
|
5094
5778
|
* @see https://redis.io/commands/hlen
|
|
5779
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hlen.mdx
|
|
5095
5780
|
*/
|
|
5096
5781
|
hlen: (...args: CommandArgs<typeof HLenCommand>) => Promise<number>;
|
|
5097
5782
|
/**
|
|
5098
5783
|
* @see https://redis.io/commands/hmget
|
|
5784
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hmget.mdx
|
|
5785
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5786
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5787
|
+
* to receive raw strings.
|
|
5788
|
+
* With automaticDeserialization: false, hmget returns an array of values in field order instead,
|
|
5789
|
+
* such as ["123", null], with null for each field when the key is missing.
|
|
5099
5790
|
*/
|
|
5100
5791
|
hmget: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof HMGetCommand>) => Promise<TData | null>;
|
|
5101
5792
|
/**
|
|
@@ -5104,6 +5795,7 @@ declare class Redis {
|
|
|
5104
5795
|
hmset: <TData>(key: string, kv: Record<string, TData>) => Promise<"OK">;
|
|
5105
5796
|
/**
|
|
5106
5797
|
* @see https://redis.io/commands/hrandfield
|
|
5798
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hrandfield.mdx
|
|
5107
5799
|
*/
|
|
5108
5800
|
hrandfield: {
|
|
5109
5801
|
(key: string): Promise<string | null>;
|
|
@@ -5112,62 +5804,83 @@ declare class Redis {
|
|
|
5112
5804
|
};
|
|
5113
5805
|
/**
|
|
5114
5806
|
* @see https://redis.io/commands/hscan
|
|
5807
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hscan.mdx
|
|
5115
5808
|
*/
|
|
5116
5809
|
hscan: (...args: CommandArgs<typeof HScanCommand>) => Promise<[string, (string | number)[]]>;
|
|
5117
5810
|
/**
|
|
5118
5811
|
* @see https://redis.io/commands/hset
|
|
5812
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hset.mdx
|
|
5119
5813
|
*/
|
|
5120
5814
|
hset: <TData>(key: string, kv: Record<string, TData>) => Promise<number>;
|
|
5121
5815
|
/**
|
|
5122
5816
|
* @see https://redis.io/commands/hsetex
|
|
5817
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hsetex.mdx
|
|
5123
5818
|
*/
|
|
5124
5819
|
hsetex: <TData>(...args: CommandArgs<typeof HSetExCommand<TData>>) => Promise<number>;
|
|
5125
5820
|
/**
|
|
5126
5821
|
* @see https://redis.io/commands/hsetnx
|
|
5822
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hsetnx.mdx
|
|
5127
5823
|
*/
|
|
5128
5824
|
hsetnx: <TData>(key: string, field: string, value: TData) => Promise<0 | 1>;
|
|
5129
5825
|
/**
|
|
5130
5826
|
* @see https://redis.io/commands/hstrlen
|
|
5827
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hstrlen.mdx
|
|
5131
5828
|
*/
|
|
5132
5829
|
hstrlen: (...args: CommandArgs<typeof HStrLenCommand>) => Promise<number>;
|
|
5133
5830
|
/**
|
|
5134
5831
|
* @see https://redis.io/commands/hvals
|
|
5832
|
+
* @see node_modules/@upstash/redis/docs/commands/hash/hvals.mdx
|
|
5135
5833
|
*/
|
|
5136
5834
|
hvals: (...args: CommandArgs<typeof HValsCommand>) => Promise<any>;
|
|
5137
5835
|
/**
|
|
5138
5836
|
* @see https://redis.io/commands/incr
|
|
5837
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incr.mdx
|
|
5139
5838
|
*/
|
|
5140
5839
|
incr: (...args: CommandArgs<typeof IncrCommand>) => Promise<number>;
|
|
5141
5840
|
/**
|
|
5142
5841
|
* @see https://redis.io/commands/incrby
|
|
5842
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incrby.mdx
|
|
5143
5843
|
*/
|
|
5144
5844
|
incrby: (...args: CommandArgs<typeof IncrByCommand>) => Promise<number>;
|
|
5145
5845
|
/**
|
|
5146
5846
|
* @see https://redis.io/commands/incrbyfloat
|
|
5847
|
+
* @see node_modules/@upstash/redis/docs/commands/string/incrbyfloat.mdx
|
|
5147
5848
|
*/
|
|
5148
5849
|
incrbyfloat: (...args: CommandArgs<typeof IncrByFloatCommand>) => Promise<number>;
|
|
5149
5850
|
/**
|
|
5150
5851
|
* @see https://redis.io/commands/keys
|
|
5852
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/keys.mdx
|
|
5151
5853
|
*/
|
|
5152
5854
|
keys: (...args: CommandArgs<typeof KeysCommand>) => Promise<string[]>;
|
|
5153
5855
|
/**
|
|
5154
5856
|
* @see https://redis.io/commands/lindex
|
|
5857
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lindex.mdx
|
|
5858
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5859
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5860
|
+
* to receive raw strings.
|
|
5155
5861
|
*/
|
|
5156
5862
|
lindex: (...args: CommandArgs<typeof LIndexCommand>) => Promise<any>;
|
|
5157
5863
|
/**
|
|
5158
5864
|
* @see https://redis.io/commands/linsert
|
|
5865
|
+
* @see node_modules/@upstash/redis/docs/commands/list/linsert.mdx
|
|
5159
5866
|
*/
|
|
5160
5867
|
linsert: <TData>(key: string, direction: "before" | "after", pivot: TData, value: TData) => Promise<number>;
|
|
5161
5868
|
/**
|
|
5162
5869
|
* @see https://redis.io/commands/llen
|
|
5870
|
+
* @see node_modules/@upstash/redis/docs/commands/list/llen.mdx
|
|
5163
5871
|
*/
|
|
5164
5872
|
llen: (...args: CommandArgs<typeof LLenCommand>) => Promise<number>;
|
|
5165
5873
|
/**
|
|
5166
5874
|
* @see https://redis.io/commands/lmove
|
|
5875
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lmove.mdx
|
|
5167
5876
|
*/
|
|
5168
5877
|
lmove: <TData = string>(...args: CommandArgs<typeof LMoveCommand>) => Promise<TData>;
|
|
5169
5878
|
/**
|
|
5170
5879
|
* @see https://redis.io/commands/lpop
|
|
5880
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpop.mdx
|
|
5881
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5882
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5883
|
+
* to receive raw strings.
|
|
5171
5884
|
*/
|
|
5172
5885
|
lpop: <TData>(...args: CommandArgs<typeof LPopCommand>) => Promise<TData | null>;
|
|
5173
5886
|
/**
|
|
@@ -5176,54 +5889,73 @@ declare class Redis {
|
|
|
5176
5889
|
lmpop: <TData>(...args: CommandArgs<typeof LmPopCommand>) => Promise<[string, TData[]] | null>;
|
|
5177
5890
|
/**
|
|
5178
5891
|
* @see https://redis.io/commands/lpos
|
|
5892
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpos.mdx
|
|
5179
5893
|
*/
|
|
5180
5894
|
lpos: <TData = number>(...args: CommandArgs<typeof LPosCommand>) => Promise<TData>;
|
|
5181
5895
|
/**
|
|
5182
5896
|
* @see https://redis.io/commands/lpush
|
|
5897
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpush.mdx
|
|
5183
5898
|
*/
|
|
5184
5899
|
lpush: <TData>(key: string, ...elements: TData[]) => Promise<number>;
|
|
5185
5900
|
/**
|
|
5186
5901
|
* @see https://redis.io/commands/lpushx
|
|
5902
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lpushx.mdx
|
|
5187
5903
|
*/
|
|
5188
5904
|
lpushx: <TData>(key: string, ...elements: TData[]) => Promise<number>;
|
|
5189
5905
|
/**
|
|
5190
5906
|
* @see https://redis.io/commands/lrange
|
|
5907
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lrange.mdx
|
|
5908
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5909
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5910
|
+
* to receive raw strings.
|
|
5191
5911
|
*/
|
|
5192
5912
|
lrange: <TResult = string>(...args: CommandArgs<typeof LRangeCommand>) => Promise<TResult[]>;
|
|
5193
5913
|
/**
|
|
5194
5914
|
* @see https://redis.io/commands/lrem
|
|
5915
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lrem.mdx
|
|
5195
5916
|
*/
|
|
5196
5917
|
lrem: <TData>(key: string, count: number, value: TData) => Promise<number>;
|
|
5197
5918
|
/**
|
|
5198
5919
|
* @see https://redis.io/commands/lset
|
|
5920
|
+
* @see node_modules/@upstash/redis/docs/commands/list/lset.mdx
|
|
5199
5921
|
*/
|
|
5200
5922
|
lset: <TData>(key: string, index: number, value: TData) => Promise<"OK">;
|
|
5201
5923
|
/**
|
|
5202
5924
|
* @see https://redis.io/commands/ltrim
|
|
5925
|
+
* @see node_modules/@upstash/redis/docs/commands/list/ltrim.mdx
|
|
5203
5926
|
*/
|
|
5204
5927
|
ltrim: (...args: CommandArgs<typeof LTrimCommand>) => Promise<"OK">;
|
|
5205
5928
|
/**
|
|
5206
5929
|
* @see https://redis.io/commands/mget
|
|
5930
|
+
* @see node_modules/@upstash/redis/docs/commands/string/mget.mdx
|
|
5931
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
5932
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
5933
|
+
* to receive raw strings.
|
|
5207
5934
|
*/
|
|
5208
5935
|
mget: <TData extends unknown[]>(...args: CommandArgs<typeof MGetCommand>) => Promise<TData>;
|
|
5209
5936
|
/**
|
|
5210
5937
|
* @see https://redis.io/commands/mset
|
|
5938
|
+
* @see node_modules/@upstash/redis/docs/commands/string/mset.mdx
|
|
5211
5939
|
*/
|
|
5212
5940
|
mset: <TData>(kv: Record<string, TData>) => Promise<"OK">;
|
|
5213
5941
|
/**
|
|
5214
5942
|
* @see https://redis.io/commands/msetnx
|
|
5943
|
+
* @see node_modules/@upstash/redis/docs/commands/string/msetnx.mdx
|
|
5215
5944
|
*/
|
|
5216
5945
|
msetnx: <TData>(kv: Record<string, TData>) => Promise<number>;
|
|
5217
5946
|
/**
|
|
5218
5947
|
* @see https://redis.io/commands/persist
|
|
5948
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/persist.mdx
|
|
5219
5949
|
*/
|
|
5220
5950
|
persist: (...args: CommandArgs<typeof PersistCommand>) => Promise<0 | 1>;
|
|
5221
5951
|
/**
|
|
5222
5952
|
* @see https://redis.io/commands/pexpire
|
|
5953
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pexpire.mdx
|
|
5223
5954
|
*/
|
|
5224
5955
|
pexpire: (...args: CommandArgs<typeof PExpireCommand>) => Promise<0 | 1>;
|
|
5225
5956
|
/**
|
|
5226
5957
|
* @see https://redis.io/commands/pexpireat
|
|
5958
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pexpireat.mdx
|
|
5227
5959
|
*/
|
|
5228
5960
|
pexpireat: (...args: CommandArgs<typeof PExpireAtCommand>) => Promise<0 | 1>;
|
|
5229
5961
|
/**
|
|
@@ -5240,6 +5972,7 @@ declare class Redis {
|
|
|
5240
5972
|
pfmerge: (...args: CommandArgs<typeof PfMergeCommand>) => Promise<"OK">;
|
|
5241
5973
|
/**
|
|
5242
5974
|
* @see https://redis.io/commands/ping
|
|
5975
|
+
* @see node_modules/@upstash/redis/docs/commands/auth/ping.mdx
|
|
5243
5976
|
*/
|
|
5244
5977
|
ping: (args?: CommandArgs<typeof PingCommand>) => Promise<string>;
|
|
5245
5978
|
/**
|
|
@@ -5248,46 +5981,64 @@ declare class Redis {
|
|
|
5248
5981
|
psetex: <TData>(key: string, ttl: number, value: TData) => Promise<string>;
|
|
5249
5982
|
/**
|
|
5250
5983
|
* @see https://redis.io/commands/psubscribe
|
|
5984
|
+
* @see node_modules/@upstash/redis/docs/commands/pubsub/psubscribe.mdx
|
|
5985
|
+
* Messages are JSON-parsed automatically: a published "123" arrives as the number 123. Unlike
|
|
5986
|
+
* subscribe, a message that is not valid JSON (such as "hello") never reaches the listener and
|
|
5987
|
+
* emits an "error" event instead. Pass automaticDeserialization: false to the Redis constructor
|
|
5988
|
+
* to receive raw strings.
|
|
5251
5989
|
*/
|
|
5252
5990
|
psubscribe: <TMessage>(patterns: string | string[]) => Subscriber<TMessage>;
|
|
5253
5991
|
/**
|
|
5254
5992
|
* @see https://redis.io/commands/pttl
|
|
5993
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/pttl.mdx
|
|
5255
5994
|
*/
|
|
5256
5995
|
pttl: (...args: CommandArgs<typeof PTtlCommand>) => Promise<number>;
|
|
5257
5996
|
/**
|
|
5258
5997
|
* @see https://redis.io/commands/publish
|
|
5998
|
+
* @see node_modules/@upstash/redis/docs/commands/pubsub/publish.mdx
|
|
5259
5999
|
*/
|
|
5260
6000
|
publish: (...args: CommandArgs<typeof PublishCommand>) => Promise<number>;
|
|
5261
6001
|
/**
|
|
5262
6002
|
* @see https://redis.io/commands/randomkey
|
|
6003
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/randomkey.mdx
|
|
5263
6004
|
*/
|
|
5264
6005
|
randomkey: () => Promise<string | null>;
|
|
5265
6006
|
/**
|
|
5266
6007
|
* @see https://redis.io/commands/rename
|
|
6008
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/rename.mdx
|
|
5267
6009
|
*/
|
|
5268
6010
|
rename: (...args: CommandArgs<typeof RenameCommand>) => Promise<"OK">;
|
|
5269
6011
|
/**
|
|
5270
6012
|
* @see https://redis.io/commands/renamenx
|
|
6013
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/renamenx.mdx
|
|
5271
6014
|
*/
|
|
5272
6015
|
renamenx: (...args: CommandArgs<typeof RenameNXCommand>) => Promise<0 | 1>;
|
|
5273
6016
|
/**
|
|
5274
6017
|
* @see https://redis.io/commands/rpop
|
|
6018
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpop.mdx
|
|
6019
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
6020
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
6021
|
+
* to receive raw strings.
|
|
5275
6022
|
*/
|
|
5276
6023
|
rpop: <TData = string>(...args: CommandArgs<typeof RPopCommand>) => Promise<TData | null>;
|
|
5277
6024
|
/**
|
|
5278
6025
|
* @see https://redis.io/commands/rpush
|
|
6026
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpush.mdx
|
|
5279
6027
|
*/
|
|
5280
6028
|
rpush: <TData>(key: string, ...elements: TData[]) => Promise<number>;
|
|
5281
6029
|
/**
|
|
5282
6030
|
* @see https://redis.io/commands/rpushx
|
|
6031
|
+
* @see node_modules/@upstash/redis/docs/commands/list/rpushx.mdx
|
|
5283
6032
|
*/
|
|
5284
6033
|
rpushx: <TData>(key: string, ...elements: TData[]) => Promise<number>;
|
|
5285
6034
|
/**
|
|
5286
6035
|
* @see https://redis.io/commands/sadd
|
|
6036
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sadd.mdx
|
|
5287
6037
|
*/
|
|
5288
6038
|
sadd: <TData>(key: string, member: TData, ...members: TData[]) => Promise<number>;
|
|
5289
6039
|
/**
|
|
5290
6040
|
* @see https://redis.io/commands/scan
|
|
6041
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/scan.mdx
|
|
5291
6042
|
*/
|
|
5292
6043
|
scan(cursor: string | number): Promise<ScanResultStandard>;
|
|
5293
6044
|
scan<TOptions extends ScanCommandOptions>(cursor: string | number, opts: TOptions): Promise<TOptions extends {
|
|
@@ -5295,34 +6046,42 @@ declare class Redis {
|
|
|
5295
6046
|
} ? ScanResultWithType : ScanResultStandard>;
|
|
5296
6047
|
/**
|
|
5297
6048
|
* @see https://redis.io/commands/scard
|
|
6049
|
+
* @see node_modules/@upstash/redis/docs/commands/set/scard.mdx
|
|
5298
6050
|
*/
|
|
5299
6051
|
scard: (...args: CommandArgs<typeof SCardCommand>) => Promise<number>;
|
|
5300
6052
|
/**
|
|
5301
6053
|
* @see https://redis.io/commands/script-exists
|
|
6054
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_exists.mdx
|
|
5302
6055
|
*/
|
|
5303
6056
|
scriptExists: (...args: CommandArgs<typeof ScriptExistsCommand>) => Promise<number[]>;
|
|
5304
6057
|
/**
|
|
5305
6058
|
* @see https://redis.io/commands/script-flush
|
|
6059
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_flush.mdx
|
|
5306
6060
|
*/
|
|
5307
6061
|
scriptFlush: (...args: CommandArgs<typeof ScriptFlushCommand>) => Promise<"OK">;
|
|
5308
6062
|
/**
|
|
5309
6063
|
* @see https://redis.io/commands/script-load
|
|
6064
|
+
* @see node_modules/@upstash/redis/docs/commands/scripts/script_load.mdx
|
|
5310
6065
|
*/
|
|
5311
6066
|
scriptLoad: (...args: CommandArgs<typeof ScriptLoadCommand>) => Promise<string>;
|
|
5312
6067
|
/**
|
|
5313
6068
|
* @see https://redis.io/commands/sdiff
|
|
6069
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sdiff.mdx
|
|
5314
6070
|
*/
|
|
5315
6071
|
sdiff: (...args: CommandArgs<typeof SDiffCommand>) => Promise<unknown[]>;
|
|
5316
6072
|
/**
|
|
5317
6073
|
* @see https://redis.io/commands/sdiffstore
|
|
6074
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sdiffstore.mdx
|
|
5318
6075
|
*/
|
|
5319
6076
|
sdiffstore: (...args: CommandArgs<typeof SDiffStoreCommand>) => Promise<number>;
|
|
5320
6077
|
/**
|
|
5321
6078
|
* @see https://redis.io/commands/set
|
|
6079
|
+
* @see node_modules/@upstash/redis/docs/commands/string/set.mdx
|
|
5322
6080
|
*/
|
|
5323
6081
|
set: <TData>(key: string, value: TData, opts?: SetCommandOptions) => Promise<"OK" | TData | null>;
|
|
5324
6082
|
/**
|
|
5325
6083
|
* @see https://redis.io/commands/setbit
|
|
6084
|
+
* @see node_modules/@upstash/redis/docs/commands/bitmap/setbit.mdx
|
|
5326
6085
|
*/
|
|
5327
6086
|
setbit: (...args: CommandArgs<typeof SetBitCommand>) => Promise<0 | 1>;
|
|
5328
6087
|
/**
|
|
@@ -5335,10 +6094,12 @@ declare class Redis {
|
|
|
5335
6094
|
setnx: <TData>(key: string, value: TData) => Promise<number>;
|
|
5336
6095
|
/**
|
|
5337
6096
|
* @see https://redis.io/commands/setrange
|
|
6097
|
+
* @see node_modules/@upstash/redis/docs/commands/string/setrange.mdx
|
|
5338
6098
|
*/
|
|
5339
6099
|
setrange: (...args: CommandArgs<typeof SetRangeCommand>) => Promise<number>;
|
|
5340
6100
|
/**
|
|
5341
6101
|
* @see https://redis.io/commands/sinter
|
|
6102
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sinter.mdx
|
|
5342
6103
|
*/
|
|
5343
6104
|
sinter: (...args: CommandArgs<typeof SInterCommand>) => Promise<string[]>;
|
|
5344
6105
|
/**
|
|
@@ -5347,54 +6108,70 @@ declare class Redis {
|
|
|
5347
6108
|
sintercard: (...args: CommandArgs<typeof SInterCardCommand>) => Promise<number>;
|
|
5348
6109
|
/**
|
|
5349
6110
|
* @see https://redis.io/commands/sinterstore
|
|
6111
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sinterstore.mdx
|
|
5350
6112
|
*/
|
|
5351
6113
|
sinterstore: (...args: CommandArgs<typeof SInterStoreCommand>) => Promise<number>;
|
|
5352
6114
|
/**
|
|
5353
6115
|
* @see https://redis.io/commands/sismember
|
|
6116
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sismember.mdx
|
|
5354
6117
|
*/
|
|
5355
6118
|
sismember: <TData>(key: string, member: TData) => Promise<0 | 1>;
|
|
5356
6119
|
/**
|
|
5357
6120
|
* @see https://redis.io/commands/smismember
|
|
6121
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smismember.mdx
|
|
5358
6122
|
*/
|
|
5359
6123
|
smismember: <TMembers extends unknown[]>(key: string, members: TMembers) => Promise<(0 | 1)[]>;
|
|
5360
6124
|
/**
|
|
5361
6125
|
* @see https://redis.io/commands/smembers
|
|
6126
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smembers.mdx
|
|
5362
6127
|
*/
|
|
5363
6128
|
smembers: <TData extends unknown[] = string[]>(...args: CommandArgs<typeof SMembersCommand>) => Promise<TData>;
|
|
5364
6129
|
/**
|
|
5365
6130
|
* @see https://redis.io/commands/smove
|
|
6131
|
+
* @see node_modules/@upstash/redis/docs/commands/set/smove.mdx
|
|
5366
6132
|
*/
|
|
5367
6133
|
smove: <TData>(source: string, destination: string, member: TData) => Promise<0 | 1>;
|
|
5368
6134
|
/**
|
|
5369
6135
|
* @see https://redis.io/commands/spop
|
|
6136
|
+
* @see node_modules/@upstash/redis/docs/commands/set/spop.mdx
|
|
5370
6137
|
*/
|
|
5371
6138
|
spop: <TData>(...args: CommandArgs<typeof SPopCommand>) => Promise<TData | null>;
|
|
5372
6139
|
/**
|
|
5373
6140
|
* @see https://redis.io/commands/srandmember
|
|
6141
|
+
* @see node_modules/@upstash/redis/docs/commands/set/srandmember.mdx
|
|
5374
6142
|
*/
|
|
5375
6143
|
srandmember: <TData>(...args: CommandArgs<typeof SRandMemberCommand>) => Promise<TData | null>;
|
|
5376
6144
|
/**
|
|
5377
6145
|
* @see https://redis.io/commands/srem
|
|
6146
|
+
* @see node_modules/@upstash/redis/docs/commands/set/srem.mdx
|
|
5378
6147
|
*/
|
|
5379
6148
|
srem: <TData>(key: string, ...members: TData[]) => Promise<number>;
|
|
5380
6149
|
/**
|
|
5381
6150
|
* @see https://redis.io/commands/sscan
|
|
6151
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sscan.mdx
|
|
5382
6152
|
*/
|
|
5383
6153
|
sscan: (...args: CommandArgs<typeof SScanCommand>) => Promise<[string, (string | number)[]]>;
|
|
5384
6154
|
/**
|
|
5385
6155
|
* @see https://redis.io/commands/strlen
|
|
6156
|
+
* @see node_modules/@upstash/redis/docs/commands/string/strlen.mdx
|
|
5386
6157
|
*/
|
|
5387
6158
|
strlen: (...args: CommandArgs<typeof StrLenCommand>) => Promise<number>;
|
|
5388
6159
|
/**
|
|
5389
6160
|
* @see https://redis.io/commands/subscribe
|
|
6161
|
+
* @see node_modules/@upstash/redis/docs/commands/pubsub/subscribe.mdx
|
|
6162
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
6163
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
6164
|
+
* to receive raw strings.
|
|
5390
6165
|
*/
|
|
5391
6166
|
subscribe: <TMessage>(channels: string | string[]) => Subscriber<TMessage>;
|
|
5392
6167
|
/**
|
|
5393
6168
|
* @see https://redis.io/commands/sunion
|
|
6169
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sunion.mdx
|
|
5394
6170
|
*/
|
|
5395
6171
|
sunion: (...args: CommandArgs<typeof SUnionCommand>) => Promise<unknown[]>;
|
|
5396
6172
|
/**
|
|
5397
6173
|
* @see https://redis.io/commands/sunionstore
|
|
6174
|
+
* @see node_modules/@upstash/redis/docs/commands/set/sunionstore.mdx
|
|
5398
6175
|
*/
|
|
5399
6176
|
sunionstore: (...args: CommandArgs<typeof SUnionStoreCommand>) => Promise<number>;
|
|
5400
6177
|
/**
|
|
@@ -5403,126 +6180,170 @@ declare class Redis {
|
|
|
5403
6180
|
time: () => Promise<[number, number]>;
|
|
5404
6181
|
/**
|
|
5405
6182
|
* @see https://redis.io/commands/touch
|
|
6183
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/touch.mdx
|
|
5406
6184
|
*/
|
|
5407
6185
|
touch: (...args: CommandArgs<typeof TouchCommand>) => Promise<number>;
|
|
5408
6186
|
/**
|
|
5409
6187
|
* @see https://redis.io/commands/ttl
|
|
6188
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/ttl.mdx
|
|
5410
6189
|
*/
|
|
5411
6190
|
ttl: (...args: CommandArgs<typeof TtlCommand>) => Promise<number>;
|
|
5412
6191
|
/**
|
|
5413
6192
|
* @see https://redis.io/commands/type
|
|
6193
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/type.mdx
|
|
5414
6194
|
*/
|
|
5415
6195
|
type: (...args: CommandArgs<typeof TypeCommand>) => Promise<Type>;
|
|
5416
6196
|
/**
|
|
5417
6197
|
* @see https://redis.io/commands/unlink
|
|
6198
|
+
* @see node_modules/@upstash/redis/docs/commands/generic/unlink.mdx
|
|
5418
6199
|
*/
|
|
5419
6200
|
unlink: (...args: CommandArgs<typeof UnlinkCommand>) => Promise<number>;
|
|
5420
6201
|
/**
|
|
5421
6202
|
* @see https://redis.io/commands/xadd
|
|
6203
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xadd.mdx
|
|
5422
6204
|
*/
|
|
5423
6205
|
xadd: (...args: CommandArgs<typeof XAddCommand>) => Promise<string>;
|
|
5424
6206
|
/**
|
|
5425
6207
|
* @see https://redis.io/commands/xack
|
|
6208
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xack.mdx
|
|
5426
6209
|
*/
|
|
5427
6210
|
xack: (...args: CommandArgs<typeof XAckCommand>) => Promise<number>;
|
|
5428
6211
|
/**
|
|
5429
6212
|
* @see https://redis.io/commands/xackdel
|
|
6213
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xackdel.mdx
|
|
5430
6214
|
*/
|
|
5431
6215
|
xackdel: (...args: CommandArgs<typeof XAckDelCommand>) => Promise<number[]>;
|
|
5432
6216
|
/**
|
|
5433
6217
|
* @see https://redis.io/commands/xdel
|
|
6218
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xdel.mdx
|
|
5434
6219
|
*/
|
|
5435
6220
|
xdel: (...args: CommandArgs<typeof XDelCommand>) => Promise<number>;
|
|
5436
6221
|
/**
|
|
5437
6222
|
* @see https://redis.io/commands/xdelex
|
|
6223
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xdelex.mdx
|
|
5438
6224
|
*/
|
|
5439
6225
|
xdelex: (...args: CommandArgs<typeof XDelExCommand>) => Promise<number[]>;
|
|
5440
6226
|
/**
|
|
5441
6227
|
* @see https://redis.io/commands/xgroup
|
|
6228
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xgroup.mdx
|
|
5442
6229
|
*/
|
|
5443
6230
|
xgroup: (...args: CommandArgs<typeof XGroupCommand>) => Promise<never>;
|
|
5444
6231
|
/**
|
|
5445
6232
|
* @see https://redis.io/commands/xread
|
|
6233
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xread.mdx
|
|
5446
6234
|
*/
|
|
5447
6235
|
xread: (...args: CommandArgs<typeof XReadCommand>) => Promise<unknown[]>;
|
|
5448
6236
|
/**
|
|
5449
6237
|
* @see https://redis.io/commands/xreadgroup
|
|
6238
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xreadgroup.mdx
|
|
5450
6239
|
*/
|
|
5451
6240
|
xreadgroup: (...args: CommandArgs<typeof XReadGroupCommand>) => Promise<unknown[]>;
|
|
5452
6241
|
/**
|
|
5453
6242
|
* @see https://redis.io/commands/xinfo
|
|
6243
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xinfo.mdx
|
|
5454
6244
|
*/
|
|
5455
6245
|
xinfo: (...args: CommandArgs<typeof XInfoCommand>) => Promise<unknown[]>;
|
|
5456
6246
|
/**
|
|
5457
6247
|
* @see https://redis.io/commands/xlen
|
|
6248
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xlen.mdx
|
|
5458
6249
|
*/
|
|
5459
6250
|
xlen: (...args: CommandArgs<typeof XLenCommand>) => Promise<number>;
|
|
5460
6251
|
/**
|
|
5461
6252
|
* @see https://redis.io/commands/xpending
|
|
6253
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xpending.mdx
|
|
5462
6254
|
*/
|
|
5463
6255
|
xpending: (...args: CommandArgs<typeof XPendingCommand>) => Promise<unknown[]>;
|
|
5464
6256
|
/**
|
|
5465
6257
|
* @see https://redis.io/commands/xclaim
|
|
6258
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xclaim.mdx
|
|
5466
6259
|
*/
|
|
5467
6260
|
xclaim: (...args: CommandArgs<typeof XClaimCommand>) => Promise<unknown[]>;
|
|
5468
6261
|
/**
|
|
5469
6262
|
* @see https://redis.io/commands/xautoclaim
|
|
6263
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xautoclaim.mdx
|
|
5470
6264
|
*/
|
|
5471
6265
|
xautoclaim: (...args: CommandArgs<typeof XAutoClaim>) => Promise<unknown[]>;
|
|
5472
6266
|
/**
|
|
5473
6267
|
* @see https://redis.io/commands/xtrim
|
|
6268
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xtrim.mdx
|
|
5474
6269
|
*/
|
|
5475
6270
|
xtrim: (...args: CommandArgs<typeof XTrimCommand>) => Promise<number>;
|
|
5476
6271
|
/**
|
|
5477
6272
|
* @see https://redis.io/commands/xrange
|
|
6273
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xrange.mdx
|
|
6274
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
6275
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
6276
|
+
* to receive raw strings.
|
|
6277
|
+
* With automaticDeserialization: false, xrange returns [id, [field, value, ...]] entries instead,
|
|
6278
|
+
* such as [["1790341484470-0", ["text", "123"]]], and [] for a missing key.
|
|
5478
6279
|
*/
|
|
5479
6280
|
xrange: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof XRangeCommand>) => Promise<Record<string, TData>>;
|
|
5480
6281
|
/**
|
|
5481
6282
|
* @see https://redis.io/commands/xrevrange
|
|
6283
|
+
* @see node_modules/@upstash/redis/docs/commands/stream/xrevrange.mdx
|
|
6284
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
6285
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
6286
|
+
* to receive raw strings.
|
|
6287
|
+
* With automaticDeserialization: false, xrevrange returns [id, [field, value, ...]] entries instead,
|
|
6288
|
+
* such as [["1790341484470-0", ["text", "123"]]], and [] for a missing key.
|
|
5482
6289
|
*/
|
|
5483
6290
|
xrevrange: <TData extends Record<string, unknown>>(...args: CommandArgs<typeof XRevRangeCommand>) => Promise<Record<string, TData>>;
|
|
5484
6291
|
/**
|
|
5485
6292
|
* @see https://redis.io/commands/zadd
|
|
6293
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zadd.mdx
|
|
5486
6294
|
*/
|
|
5487
6295
|
zadd: <TData>(...args: [key: string, scoreMember: ScoreMember<TData>, ...scoreMemberPairs: ScoreMember<TData>[]] | [key: string, opts: ZAddCommandOptions, ...scoreMemberPairs: [ScoreMember<TData>, ...ScoreMember<TData>[]]]) => Promise<number | null>;
|
|
5488
6296
|
/**
|
|
5489
6297
|
* @see https://redis.io/commands/zcard
|
|
6298
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zcard.mdx
|
|
5490
6299
|
*/
|
|
5491
6300
|
zcard: (...args: CommandArgs<typeof ZCardCommand>) => Promise<number>;
|
|
5492
6301
|
/**
|
|
5493
6302
|
* @see https://redis.io/commands/zcount
|
|
6303
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zcount.mdx
|
|
5494
6304
|
*/
|
|
5495
6305
|
zcount: (...args: CommandArgs<typeof ZCountCommand>) => Promise<number>;
|
|
5496
6306
|
/**
|
|
5497
6307
|
* @see https://redis.io/commands/zdiffstore
|
|
6308
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zdiffstore.mdx
|
|
5498
6309
|
*/
|
|
5499
6310
|
zdiffstore: (...args: CommandArgs<typeof ZDiffStoreCommand>) => Promise<number>;
|
|
5500
6311
|
/**
|
|
5501
6312
|
* @see https://redis.io/commands/zincrby
|
|
6313
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zincrby.mdx
|
|
5502
6314
|
*/
|
|
5503
6315
|
zincrby: <TData>(key: string, increment: number, member: TData) => Promise<number>;
|
|
5504
6316
|
/**
|
|
5505
6317
|
* @see https://redis.io/commands/zinterstore
|
|
6318
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zinterstore.mdx
|
|
5506
6319
|
*/
|
|
5507
6320
|
zinterstore: (...args: CommandArgs<typeof ZInterStoreCommand>) => Promise<number>;
|
|
5508
6321
|
/**
|
|
5509
6322
|
* @see https://redis.io/commands/zlexcount
|
|
6323
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zlexcount.mdx
|
|
5510
6324
|
*/
|
|
5511
6325
|
zlexcount: (...args: CommandArgs<typeof ZLexCountCommand>) => Promise<number>;
|
|
5512
6326
|
/**
|
|
5513
6327
|
* @see https://redis.io/commands/zmscore
|
|
6328
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zmscore.mdx
|
|
5514
6329
|
*/
|
|
5515
6330
|
zmscore: (...args: CommandArgs<typeof ZMScoreCommand>) => Promise<number[] | null>;
|
|
5516
6331
|
/**
|
|
5517
6332
|
* @see https://redis.io/commands/zpopmax
|
|
6333
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zpopmax.mdx
|
|
5518
6334
|
*/
|
|
5519
6335
|
zpopmax: <TData>(...args: CommandArgs<typeof ZPopMaxCommand>) => Promise<TData[]>;
|
|
5520
6336
|
/**
|
|
5521
6337
|
* @see https://redis.io/commands/zpopmin
|
|
6338
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zpopmin.mdx
|
|
5522
6339
|
*/
|
|
5523
6340
|
zpopmin: <TData>(...args: CommandArgs<typeof ZPopMinCommand>) => Promise<TData[]>;
|
|
5524
6341
|
/**
|
|
5525
6342
|
* @see https://redis.io/commands/zrange
|
|
6343
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrange.mdx
|
|
6344
|
+
* Responses are JSON-parsed automatically: a stored "123" comes back as the number 123, "true" as
|
|
6345
|
+
* true, and '{"a":1}' as an object. Pass automaticDeserialization: false to the Redis constructor
|
|
6346
|
+
* to receive raw strings.
|
|
5526
6347
|
*/
|
|
5527
6348
|
zrange: <TData extends unknown[]>(...args: [key: string, min: number, max: number, opts?: ZRangeCommandOptions] | [key: string, min: `(${string}` | `[${string}` | "-" | "+", max: `(${string}` | `[${string}` | "-" | "+", opts: {
|
|
5528
6349
|
byLex: true;
|
|
@@ -5531,34 +6352,42 @@ declare class Redis {
|
|
|
5531
6352
|
} & ZRangeCommandOptions]) => Promise<TData>;
|
|
5532
6353
|
/**
|
|
5533
6354
|
* @see https://redis.io/commands/zrank
|
|
6355
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrank.mdx
|
|
5534
6356
|
*/
|
|
5535
6357
|
zrank: <TData>(key: string, member: TData) => Promise<number | null>;
|
|
5536
6358
|
/**
|
|
5537
6359
|
* @see https://redis.io/commands/zrem
|
|
6360
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrem.mdx
|
|
5538
6361
|
*/
|
|
5539
6362
|
zrem: <TData>(key: string, ...members: TData[]) => Promise<number>;
|
|
5540
6363
|
/**
|
|
5541
6364
|
* @see https://redis.io/commands/zremrangebylex
|
|
6365
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebylex.mdx
|
|
5542
6366
|
*/
|
|
5543
6367
|
zremrangebylex: (...args: CommandArgs<typeof ZRemRangeByLexCommand>) => Promise<number>;
|
|
5544
6368
|
/**
|
|
5545
6369
|
* @see https://redis.io/commands/zremrangebyrank
|
|
6370
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyrank.mdx
|
|
5546
6371
|
*/
|
|
5547
6372
|
zremrangebyrank: (...args: CommandArgs<typeof ZRemRangeByRankCommand>) => Promise<number>;
|
|
5548
6373
|
/**
|
|
5549
6374
|
* @see https://redis.io/commands/zremrangebyscore
|
|
6375
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zremrangebyscore.mdx
|
|
5550
6376
|
*/
|
|
5551
6377
|
zremrangebyscore: (...args: CommandArgs<typeof ZRemRangeByScoreCommand>) => Promise<number>;
|
|
5552
6378
|
/**
|
|
5553
6379
|
* @see https://redis.io/commands/zrevrank
|
|
6380
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zrevrank.mdx
|
|
5554
6381
|
*/
|
|
5555
6382
|
zrevrank: <TData>(key: string, member: TData) => Promise<number | null>;
|
|
5556
6383
|
/**
|
|
5557
6384
|
* @see https://redis.io/commands/zscan
|
|
6385
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zscan.mdx
|
|
5558
6386
|
*/
|
|
5559
6387
|
zscan: (...args: CommandArgs<typeof ZScanCommand>) => Promise<[string, (string | number)[]]>;
|
|
5560
6388
|
/**
|
|
5561
6389
|
* @see https://redis.io/commands/zscore
|
|
6390
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zscore.mdx
|
|
5562
6391
|
*/
|
|
5563
6392
|
zscore: <TData>(key: string, member: TData) => Promise<number | null>;
|
|
5564
6393
|
/**
|
|
@@ -5567,6 +6396,7 @@ declare class Redis {
|
|
|
5567
6396
|
zunion: (...args: CommandArgs<typeof ZUnionCommand>) => Promise<any>;
|
|
5568
6397
|
/**
|
|
5569
6398
|
* @see https://redis.io/commands/zunionstore
|
|
6399
|
+
* @see node_modules/@upstash/redis/docs/commands/zset/zunionstore.mdx
|
|
5570
6400
|
*/
|
|
5571
6401
|
zunionstore: (...args: CommandArgs<typeof ZUnionStoreCommand>) => Promise<number>;
|
|
5572
6402
|
}
|