@devvit/public-api 0.11.0-next-2024-07-30-2398bf2d4.0 → 0.11.0-next-2024-07-30-0415fdb14.0
Sign up to get free protection for your applications and to get access to all the features.
- package/apis/redis/RedisClient.js +2 -2
- package/devvit/internals/blocks/handler/BlocksHandler.d.ts.map +1 -1
- package/devvit/internals/blocks/handler/BlocksHandler.js +7 -0
- package/devvit/internals/blocks/handler/useAsync.d.ts +11 -0
- package/devvit/internals/blocks/handler/useAsync.d.ts.map +1 -1
- package/devvit/internals/blocks/handler/useAsync.js +21 -9
- package/devvit/internals/blocks/handler/useState.d.ts.map +1 -1
- package/devvit/internals/blocks/handler/useState.js +6 -2
- package/devvit/internals/context.js +1 -1
- package/meta.json +162 -140
- package/meta.min.json +106 -84
- package/package.json +9 -9
- package/public-api.d.ts +750 -0
- package/public-api.iife.js +964 -1339
- package/public-api.min.js +5 -5
- package/public-api.min.js.map +4 -4
- package/types/redis.d.ts +750 -0
- package/types/redis.d.ts.map +1 -1
- package/version.json +2 -2
package/public-api.d.ts
CHANGED
@@ -45978,6 +45978,18 @@ export declare type RedisClient = {
|
|
45978
45978
|
* Marks the given keys to be watched for conditional execution of a transaction.
|
45979
45979
|
* https://redis.io/commands/watch/
|
45980
45980
|
* @arg {} keys - given keys to be watched
|
45981
|
+
* @example
|
45982
|
+
* ```ts
|
45983
|
+
* async function watchExample(context: Devvit.Context) {
|
45984
|
+
* await context.redis.set("karma", "32");
|
45985
|
+
*
|
45986
|
+
* const txn = await context.redis.watch("quantity");
|
45987
|
+
*
|
45988
|
+
* await txn.multi(); // Begin a transaction
|
45989
|
+
* await txn.incrBy("karma", 10);
|
45990
|
+
* await txn.exec(); // Execute the commands in the transaction
|
45991
|
+
* }
|
45992
|
+
* ```
|
45981
45993
|
*/
|
45982
45994
|
watch(...keys: string[]): Promise<TxClientLike>;
|
45983
45995
|
/**
|
@@ -45985,6 +45997,14 @@ export declare type RedisClient = {
|
|
45985
45997
|
* https://redis.io/commands/get/
|
45986
45998
|
* @arg {} key
|
45987
45999
|
* @returns value of key or null when key does not exist.
|
46000
|
+
* @example
|
46001
|
+
* ```ts
|
46002
|
+
* async function getExample(context: Devvit.Context) {
|
46003
|
+
* await context.redis.set("quantity", "5");
|
46004
|
+
* const quantity : string | undefined = await context.redis.get("quantity");
|
46005
|
+
* console.log("Quantity: " + quantity);
|
46006
|
+
* }
|
46007
|
+
* ```
|
45988
46008
|
*/
|
45989
46009
|
get(key: string): Promise<string | undefined>;
|
45990
46010
|
/**
|
@@ -45993,12 +46013,25 @@ export declare type RedisClient = {
|
|
45993
46013
|
* @arg {} key
|
45994
46014
|
* @arg {} value
|
45995
46015
|
* @arg {} options
|
46016
|
+
* @example
|
46017
|
+
* ```ts
|
46018
|
+
* async function setExample(context: Devvit.Context) {
|
46019
|
+
* await context.redis.set("quantity", "5");
|
46020
|
+
* }
|
46021
|
+
* ```
|
45996
46022
|
*/
|
45997
46023
|
set(key: string, value: string, options?: SetOptions): Promise<string>;
|
45998
46024
|
/**
|
45999
46025
|
* Removes the specified keys. A key is ignored if it does not exist.
|
46000
46026
|
* https://redis.io/commands/del/
|
46001
46027
|
* @arg {} keys
|
46028
|
+
* @example
|
46029
|
+
* ```ts
|
46030
|
+
* async function delExample(context: Devvit.Context) {
|
46031
|
+
* await context.redis.set("quantity", "5");
|
46032
|
+
* await context.redis.del("quantity");
|
46033
|
+
* }
|
46034
|
+
* ```
|
46002
46035
|
*/
|
46003
46036
|
del(...keys: string[]): Promise<void>;
|
46004
46037
|
/**
|
@@ -46006,6 +46039,14 @@ export declare type RedisClient = {
|
|
46006
46039
|
* https://redis.io/commands/type/
|
46007
46040
|
* @arg {} key
|
46008
46041
|
* @returns string representation of the type
|
46042
|
+
* @example
|
46043
|
+
* ```ts
|
46044
|
+
* async function typeExample(context: Devvit.Context) {
|
46045
|
+
* await context.redis.set("quantity", "5");
|
46046
|
+
* const type : string = await context.redis.type("quantity");
|
46047
|
+
* console.log("Key type: " + type);
|
46048
|
+
* }
|
46049
|
+
* ```
|
46009
46050
|
*/
|
46010
46051
|
type(key: string): Promise<string>;
|
46011
46052
|
/**
|
@@ -46016,6 +46057,14 @@ export declare type RedisClient = {
|
|
46016
46057
|
* @arg {} start
|
46017
46058
|
* @arg {} end
|
46018
46059
|
* @returns substring determined by offsets [start, end]
|
46060
|
+
* @example
|
46061
|
+
* ```ts
|
46062
|
+
* async function getRangeExample(context: Devvit.Context) {
|
46063
|
+
* await context.redis.set("word", "tacocat");
|
46064
|
+
* const range : string = await context.redis.getRange("word", 0, 3)
|
46065
|
+
* console.log("Range from index 0 to 3: " + range);
|
46066
|
+
* }
|
46067
|
+
* ```
|
46019
46068
|
*/
|
46020
46069
|
getRange(key: string, start: number, end: number): Promise<string>;
|
46021
46070
|
/**
|
@@ -46025,6 +46074,13 @@ export declare type RedisClient = {
|
|
46025
46074
|
* @arg {} key
|
46026
46075
|
* @arg {} offset
|
46027
46076
|
* @returns length of the string after it was modified by the command
|
46077
|
+
* @example
|
46078
|
+
* ```ts
|
46079
|
+
* async function setRangeExample(context: Devvit.Context) {
|
46080
|
+
* await context.redis.set("word", "tacocat");
|
46081
|
+
* await context.redis.setRange("word", 0, "blue");
|
46082
|
+
* }
|
46083
|
+
* ```
|
46028
46084
|
*/
|
46029
46085
|
setRange(key: string, offset: number, value: string): Promise<number>;
|
46030
46086
|
/**
|
@@ -46042,6 +46098,14 @@ export declare type RedisClient = {
|
|
46042
46098
|
* https://redis.io/commands/strlen/
|
46043
46099
|
* @arg {} key
|
46044
46100
|
* @returns length of the string stored at key
|
46101
|
+
* @example
|
46102
|
+
* ```ts
|
46103
|
+
* async function strLenExample(context: Devvit.Context) {
|
46104
|
+
* await context.redis.set("word", "tacocat");
|
46105
|
+
* const length : number = await context.redis.strLen("word");
|
46106
|
+
* console.log("Length of word: " + length);
|
46107
|
+
* }
|
46108
|
+
* ```
|
46045
46109
|
*/
|
46046
46110
|
strLen(key: string): Promise<number>;
|
46047
46111
|
/**
|
@@ -46050,6 +46114,14 @@ export declare type RedisClient = {
|
|
46050
46114
|
* @arg {} key
|
46051
46115
|
* @arg {} value
|
46052
46116
|
* @returns value of key after the increment
|
46117
|
+
* @example
|
46118
|
+
* ```ts
|
46119
|
+
* async function incrByExample(context: Devvit.Context) {
|
46120
|
+
* await context.redis.set("totalPoints", "53")
|
46121
|
+
* const updatedPoints : number = await context.redis.incrBy("totalPoints", 100);
|
46122
|
+
* console.log("Updated points: " + updatedPoints);
|
46123
|
+
* }
|
46124
|
+
* ```
|
46053
46125
|
*/
|
46054
46126
|
incrBy(key: string, value: number): Promise<number>;
|
46055
46127
|
/**
|
@@ -46065,6 +46137,16 @@ export declare type RedisClient = {
|
|
46065
46137
|
* https://redis.io/commands/mget/
|
46066
46138
|
* @arg {} keys
|
46067
46139
|
* @returns list of values at the specified keys
|
46140
|
+
* @example
|
46141
|
+
* ```ts
|
46142
|
+
* async function mGetExample(context: Devvit.Context) {
|
46143
|
+
* await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
|
46144
|
+
* const result : (string | null)[] = await context.redis.mGet(["name", "occupation"]);
|
46145
|
+
* result.forEach(x => {
|
46146
|
+
* console.log(x);
|
46147
|
+
* });
|
46148
|
+
* }
|
46149
|
+
* ```
|
46068
46150
|
*/
|
46069
46151
|
mGet(keys: string[]): Promise<(string | null)[]>;
|
46070
46152
|
/**
|
@@ -46080,6 +46162,12 @@ export declare type RedisClient = {
|
|
46080
46162
|
* Sets the given keys to their respective values.
|
46081
46163
|
* https://redis.io/commands/mset/
|
46082
46164
|
* @arg {} keyValues
|
46165
|
+
* @example
|
46166
|
+
* ```ts
|
46167
|
+
* async function mSetExample(context: Devvit.Context) {
|
46168
|
+
* await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
|
46169
|
+
* }
|
46170
|
+
* ```
|
46083
46171
|
*/
|
46084
46172
|
mSet(keyValues: {
|
46085
46173
|
[key: string]: string;
|
@@ -46089,6 +46177,13 @@ export declare type RedisClient = {
|
|
46089
46177
|
* https://redis.io/commands/expire/
|
46090
46178
|
* @arg {} key
|
46091
46179
|
* @arg {} seconds
|
46180
|
+
* @example
|
46181
|
+
* ```ts
|
46182
|
+
* async function expireExample(context: Devvit.Context) {
|
46183
|
+
* await context.redis.set("product", "milk");
|
46184
|
+
* await context.redis.expire("product", 60); // Set the product to expire in 60 seconds
|
46185
|
+
* }
|
46186
|
+
* ```
|
46092
46187
|
*/
|
46093
46188
|
expire(key: string, seconds: number): Promise<void>;
|
46094
46189
|
/**
|
@@ -46096,6 +46191,12 @@ export declare type RedisClient = {
|
|
46096
46191
|
* https://redis.io/commands/expiretime/
|
46097
46192
|
* @arg {} key
|
46098
46193
|
* @returns expiration Unix timestamp in seconds, or a negative value in order to signal an error
|
46194
|
+
* @example
|
46195
|
+
* async function expireTimeExample(context: Devvit.Context) {
|
46196
|
+
* await context.redis.set("product", "milk");
|
46197
|
+
* const expireTime : number = await context.redis.expireTime("product");
|
46198
|
+
* console.log("Expire time: " + expireTime);
|
46199
|
+
* }
|
46099
46200
|
*/
|
46100
46201
|
expireTime(key: string): Promise<number>;
|
46101
46202
|
/**
|
@@ -46103,6 +46204,18 @@ export declare type RedisClient = {
|
|
46103
46204
|
* https://redis.io/commands/zadd/
|
46104
46205
|
* @arg {} key
|
46105
46206
|
* @returns number of elements added to the sorted set
|
46207
|
+
* @example
|
46208
|
+
* ```ts
|
46209
|
+
* async function zAddExample(context: Devvit.Context) {
|
46210
|
+
* const numMembersAdded : number = await context.redis.zAdd("leaderboard",
|
46211
|
+
* {member: "louis", score: 37},
|
46212
|
+
* {member: "fernando", score: 10},
|
46213
|
+
* {member: "caesar", score: 20},
|
46214
|
+
* {member: "alexander", score: 25},
|
46215
|
+
* );
|
46216
|
+
* console.log("Number of members added: " + numMembersAdded);
|
46217
|
+
* }
|
46218
|
+
* ```
|
46106
46219
|
*/
|
46107
46220
|
zAdd(key: string, ...members: ZMember[]): Promise<number>;
|
46108
46221
|
/**
|
@@ -46110,6 +46223,19 @@ export declare type RedisClient = {
|
|
46110
46223
|
* https://redis.io/commands/zcard/
|
46111
46224
|
* @arg {} key
|
46112
46225
|
* @returns cardinality of the sorted set
|
46226
|
+
* @example
|
46227
|
+
* ```ts
|
46228
|
+
* async function zCardExample(context: Devvit.Context) {
|
46229
|
+
* await context.redis.zAdd("leaderboard",
|
46230
|
+
* {member: "louis", score: 37},
|
46231
|
+
* {member: "fernando", score: 10},
|
46232
|
+
* {member: "caesar", score: 20},
|
46233
|
+
* {member: "alexander", score: 25},
|
46234
|
+
* );
|
46235
|
+
* const cardinality : number = await context.redis.zCard("leaderboard");
|
46236
|
+
* console.log("Cardinality: " + cardinality);
|
46237
|
+
* }
|
46238
|
+
* ```
|
46113
46239
|
*/
|
46114
46240
|
zCard(key: string): Promise<number>;
|
46115
46241
|
/**
|
@@ -46118,6 +46244,19 @@ export declare type RedisClient = {
|
|
46118
46244
|
* @arg {} key
|
46119
46245
|
* @arg {} member
|
46120
46246
|
* @returns the score of the member (a double-precision floating point number).
|
46247
|
+
* @example
|
46248
|
+
* ```ts
|
46249
|
+
* async function zScoreExample(context: Devvit.Context) {
|
46250
|
+
* await context.redis.zAdd("leaderboard",
|
46251
|
+
* {member: "louis", score: 37},
|
46252
|
+
* {member: "fernando", score: 10},
|
46253
|
+
* {member: "caesar", score: 20},
|
46254
|
+
* {member: "alexander", score: 25},
|
46255
|
+
* );
|
46256
|
+
* const score : number = await context.redis.zScore("leaderboard", "caesar");
|
46257
|
+
* console.log("Caesar's score: " + score);
|
46258
|
+
* }
|
46259
|
+
* ```
|
46121
46260
|
*/
|
46122
46261
|
zScore(key: string, member: string): Promise<number>;
|
46123
46262
|
/**
|
@@ -46127,6 +46266,19 @@ export declare type RedisClient = {
|
|
46127
46266
|
* @arg {} member
|
46128
46267
|
* @returns rank of the member. The rank (or index) is 0-based
|
46129
46268
|
* which means that the member with the lowest score has rank 0
|
46269
|
+
* @example
|
46270
|
+
* ```ts
|
46271
|
+
* async function zRankExample(context: Devvit.Context) {
|
46272
|
+
* await context.redis.zAdd("animals",
|
46273
|
+
* {member: "zebra", score: 92},
|
46274
|
+
* {member: "cat", score: 100},
|
46275
|
+
* {member: "dog", score: 95},
|
46276
|
+
* {member: "elephant", score: 97}
|
46277
|
+
* );
|
46278
|
+
* const rank : number = await context.redis.zRank("animals", "dog");
|
46279
|
+
* console.log("Dog's rank: " + rank);
|
46280
|
+
* }
|
46281
|
+
* ```
|
46130
46282
|
*/
|
46131
46283
|
zRank(key: string, member: string): Promise<number>;
|
46132
46284
|
/**
|
@@ -46136,6 +46288,19 @@ export declare type RedisClient = {
|
|
46136
46288
|
* @arg {} member
|
46137
46289
|
* @arg {} value
|
46138
46290
|
* @returns the new score of member as a double precision floating point number
|
46291
|
+
* @example
|
46292
|
+
* ```ts
|
46293
|
+
* async function zIncrByExample(context: Devvit.Context) {
|
46294
|
+
* await context.redis.zAdd("animals",
|
46295
|
+
* {member: "zebra", score: 92},
|
46296
|
+
* {member: "cat", score: 100},
|
46297
|
+
* {member: "dog", score: 95},
|
46298
|
+
* {member: "elephant", score: 97}
|
46299
|
+
* );
|
46300
|
+
* const updatedScore : number = await context.redis.zIncrBy("animals", "dog", 10);
|
46301
|
+
* console.log("Dog's updated score: " + updatedScore);
|
46302
|
+
* }
|
46303
|
+
* ```
|
46139
46304
|
*/
|
46140
46305
|
zIncrBy(key: string, member: string, value: number): Promise<number>;
|
46141
46306
|
/**
|
@@ -46146,6 +46311,24 @@ export declare type RedisClient = {
|
|
46146
46311
|
* @arg {} stop
|
46147
46312
|
* @arg {} options
|
46148
46313
|
* @returns list of elements in the specified range
|
46314
|
+
* @example
|
46315
|
+
* ```ts
|
46316
|
+
* async function zRangeExample(context: Devvit.Context) {
|
46317
|
+
* await context.redis.zAdd("leaderboard",
|
46318
|
+
* {member: "louis", score: 37},
|
46319
|
+
* {member: "fernando", score: 10},
|
46320
|
+
* {member: "caesar", score: 20},
|
46321
|
+
* {member: "alexander", score: 25},
|
46322
|
+
* );
|
46323
|
+
*
|
46324
|
+
* // View elements with scores between 0 and 30 inclusive, sorted by score
|
46325
|
+
* const scores : {member : string, score : number}[] = await context.redis.zRange("leaderboard", 0, 30, { by: "score" });
|
46326
|
+
*
|
46327
|
+
* scores.forEach(x => {
|
46328
|
+
* console.log("Member: " + x.member, ", Score: " + x.score);
|
46329
|
+
* });
|
46330
|
+
* }
|
46331
|
+
* ```
|
46149
46332
|
*/
|
46150
46333
|
zRange(key: string, start: number | string, stop: number | string, options?: ZRangeOptions): Promise<{
|
46151
46334
|
member: string;
|
@@ -46157,6 +46340,19 @@ export declare type RedisClient = {
|
|
46157
46340
|
* @arg {} key
|
46158
46341
|
* @arg {} members
|
46159
46342
|
* @returns number of members removed from the sorted set
|
46343
|
+
* @example
|
46344
|
+
* ```ts
|
46345
|
+
* async function zRemExample(context: Devvit.Context) {
|
46346
|
+
* await context.redis.zAdd("leaderboard",
|
46347
|
+
* {member: "louis", score: 37},
|
46348
|
+
* {member: "fernando", score: 10},
|
46349
|
+
* {member: "caesar", score: 20},
|
46350
|
+
* {member: "alexander", score: 25},
|
46351
|
+
* );
|
46352
|
+
* const numberOfMembersRemoved : number = await context.redis.zRem("leaderboard", ["fernando", "alexander"]);
|
46353
|
+
* console.log("Number of members removed: " + numberOfMembersRemoved);
|
46354
|
+
* }
|
46355
|
+
* ```
|
46160
46356
|
*/
|
46161
46357
|
zRem(key: string, members: string[]): Promise<number>;
|
46162
46358
|
/**
|
@@ -46167,6 +46363,23 @@ export declare type RedisClient = {
|
|
46167
46363
|
* @arg {} min
|
46168
46364
|
* @arg {} max
|
46169
46365
|
* @returns number of members removed from the sorted set
|
46366
|
+
* @example
|
46367
|
+
* ```ts
|
46368
|
+
* async function zRemRangeByLexExample(context: Devvit.Context) {
|
46369
|
+
* await context.redis.zAdd("fruits",
|
46370
|
+
* {member: "kiwi", score: 0},
|
46371
|
+
* {member: "mango", score: 0},
|
46372
|
+
* {member: "banana", score: 0},
|
46373
|
+
* {member: "orange", score: 0},
|
46374
|
+
* {member: "apple", score: 0},
|
46375
|
+
* );
|
46376
|
+
*
|
46377
|
+
* // Remove fruits alphabetically ordered between 'kiwi' inclusive and 'orange' exclusive
|
46378
|
+
* // Note: The symbols '[' and '(' indicate inclusive or exclusive, respectively. These must be included in the call to zRemRangeByLex().
|
46379
|
+
* const numFieldsRemoved : number = await context.redis.zRemRangeByLex("fruits", "[kiwi", "(orange");
|
46380
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
46381
|
+
* }
|
46382
|
+
* ```
|
46170
46383
|
*/
|
46171
46384
|
zRemRangeByLex(key: string, min: string, max: string): Promise<number>;
|
46172
46385
|
/**
|
@@ -46176,6 +46389,22 @@ export declare type RedisClient = {
|
|
46176
46389
|
* @arg {} start
|
46177
46390
|
* @arg {} stop
|
46178
46391
|
* @returns number of members removed from the sorted set
|
46392
|
+
* @example
|
46393
|
+
* ```
|
46394
|
+
* async function zRemRangeByRankExample(context: Devvit.Context) {
|
46395
|
+
* await context.redis.zAdd("fruits",
|
46396
|
+
* {member: "kiwi", score: 10},
|
46397
|
+
* {member: "mango", score: 20},
|
46398
|
+
* {member: "banana", score: 30},
|
46399
|
+
* {member: "orange", score: 40},
|
46400
|
+
* {member: "apple", score: 50},
|
46401
|
+
* );
|
46402
|
+
|
46403
|
+
* // Remove fruits ranked 1 through 3 inclusive
|
46404
|
+
* const numFieldsRemoved : number = await context.redis.zRemRangeByRank("fruits", 1, 3);
|
46405
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
46406
|
+
* }
|
46407
|
+
* ```
|
46179
46408
|
*/
|
46180
46409
|
zRemRangeByRank(key: string, start: number, stop: number): Promise<number>;
|
46181
46410
|
/**
|
@@ -46185,6 +46414,21 @@ export declare type RedisClient = {
|
|
46185
46414
|
* @arg {} min
|
46186
46415
|
* @arg {} max
|
46187
46416
|
* @returns number of members removed from the sorted set
|
46417
|
+
* @example
|
46418
|
+
* ```ts
|
46419
|
+
* async function zRemRangeByScoreExample(context: Devvit.Context) {
|
46420
|
+
* await context.redis.zAdd("fruits",
|
46421
|
+
* {member: "kiwi", score: 10},
|
46422
|
+
* {member: "mango", score: 20},
|
46423
|
+
* {member: "banana", score: 30},
|
46424
|
+
* {member: "orange", score: 40},
|
46425
|
+
* {member: "apple", score: 50},
|
46426
|
+
* );
|
46427
|
+
* // Remove fruits scored between 30 and 50 inclusive
|
46428
|
+
* const numFieldsRemoved : number = await context.redis.zRemRangeByScore("fruits", 30, 50);
|
46429
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
46430
|
+
* }
|
46431
|
+
* ```
|
46188
46432
|
*/
|
46189
46433
|
zRemRangeByScore(key: string, min: number, max: number): Promise<number>;
|
46190
46434
|
/**
|
@@ -46193,6 +46437,20 @@ export declare type RedisClient = {
|
|
46193
46437
|
* @arg {} cursor
|
46194
46438
|
* @arg {} pattern
|
46195
46439
|
* @arg {} count
|
46440
|
+
* @example
|
46441
|
+
* ```ts
|
46442
|
+
* async function zScanExample(context: Devvit.Context) {
|
46443
|
+
* await context.redis.zAdd("fruits",
|
46444
|
+
* {member: "kiwi", score: 0},
|
46445
|
+
* {member: "mango", score: 0},
|
46446
|
+
* {member: "banana", score: 0},
|
46447
|
+
* {member: "orange", score: 0},
|
46448
|
+
* {member: "apple", score: 0},
|
46449
|
+
* );
|
46450
|
+
* const zScanResponse = await context.redis.zScan("fruits", 0);
|
46451
|
+
* console.log("zScanResponse: " + JSON.stringify(zScanResponse));
|
46452
|
+
* }
|
46453
|
+
* ```
|
46196
46454
|
*/
|
46197
46455
|
zScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<ZScanResponse>;
|
46198
46456
|
/**
|
@@ -46212,6 +46470,13 @@ export declare type RedisClient = {
|
|
46212
46470
|
* @arg {} key
|
46213
46471
|
* @arg {} fieldValues
|
46214
46472
|
* @returns number of fields that were added
|
46473
|
+
* @example
|
46474
|
+
* ```ts
|
46475
|
+
* async function hSetExample(context: Devvit.Context) {
|
46476
|
+
* const numFieldsAdded = await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
|
46477
|
+
* console.log("Number of fields added: " + numFieldsAdded);
|
46478
|
+
* }
|
46479
|
+
* ```
|
46215
46480
|
*/
|
46216
46481
|
hSet(key: string, fieldValues: {
|
46217
46482
|
[field: string]: string;
|
@@ -46231,6 +46496,14 @@ export declare type RedisClient = {
|
|
46231
46496
|
* @arg {} key
|
46232
46497
|
* @arg {} field
|
46233
46498
|
* @returns value associated with field
|
46499
|
+
* @example
|
46500
|
+
* ```ts
|
46501
|
+
* async function hGetExample(context: Devvit.Context) {
|
46502
|
+
* await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
|
46503
|
+
* const result : string | undefined = await context.redis.hGet("fruits", "orange");
|
46504
|
+
* console.log("Value of orange: " + result);
|
46505
|
+
* }
|
46506
|
+
* ```
|
46234
46507
|
*/
|
46235
46508
|
hGet(key: string, field: string): Promise<string | undefined>;
|
46236
46509
|
/**
|
@@ -46246,6 +46519,22 @@ export declare type RedisClient = {
|
|
46246
46519
|
* https://redis.io/commands/hgetall
|
46247
46520
|
* @arg {} key
|
46248
46521
|
* @returns a map of fields and their values stored in the hash,
|
46522
|
+
* @example
|
46523
|
+
* ```
|
46524
|
+
* async function hGetAllExample(context: Devvit.Context) {
|
46525
|
+
* await context.redis.hSet("groceryList", {
|
46526
|
+
* "eggs": "12",
|
46527
|
+
* "apples": "3",
|
46528
|
+
* "milk": "1"
|
46529
|
+
* });
|
46530
|
+
*
|
46531
|
+
* const record : Record<string, string> | undefined = await context.redis.hGetAll("groceryList");
|
46532
|
+
*
|
46533
|
+
* if (record != undefined) {
|
46534
|
+
* console.log("Eggs: " + record.eggs + ", Apples: " + record.apples + ", Milk: " + record.milk);
|
46535
|
+
* }
|
46536
|
+
* }
|
46537
|
+
* ```
|
46249
46538
|
*/
|
46250
46539
|
hGetAll(key: string): Promise<Record<string, string> | undefined>;
|
46251
46540
|
/**
|
@@ -46263,6 +46552,14 @@ export declare type RedisClient = {
|
|
46263
46552
|
* @arg {} key
|
46264
46553
|
* @arg {} fields
|
46265
46554
|
* @returns number of fields that were removed from the hash
|
46555
|
+
* @example
|
46556
|
+
* ```ts
|
46557
|
+
* async function hDelExample(context: Devvit.Context) {
|
46558
|
+
* await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
|
46559
|
+
* const numFieldsRemoved = await context.redis.hDel("fruits", ["apple", "kiwi"]);
|
46560
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
46561
|
+
* }
|
46562
|
+
* ```
|
46266
46563
|
*/
|
46267
46564
|
hDel(key: string, fields: string[]): Promise<number>;
|
46268
46565
|
/**
|
@@ -46280,6 +46577,22 @@ export declare type RedisClient = {
|
|
46280
46577
|
* @arg {} cursor
|
46281
46578
|
* @arg {} pattern
|
46282
46579
|
* @arg {} count
|
46580
|
+
* @example
|
46581
|
+
* ```ts
|
46582
|
+
* async function hScanExample(context: Devvit.Context) {
|
46583
|
+
* await context.redis.hSet("userInfo", {
|
46584
|
+
* "name": "Bob",
|
46585
|
+
* "startDate": "01-05-20",
|
46586
|
+
* "totalAwards": "12"
|
46587
|
+
* });
|
46588
|
+
*
|
46589
|
+
* const hScanResponse = await context.redis.hScan("userInfo", 0);
|
46590
|
+
*
|
46591
|
+
* hScanResponse.fieldValues.forEach(x => {
|
46592
|
+
* console.log("Field: '" + x.field + "', Value: '" + x.value + "'");
|
46593
|
+
* });
|
46594
|
+
* }
|
46595
|
+
* ```
|
46283
46596
|
*/
|
46284
46597
|
hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
|
46285
46598
|
/**
|
@@ -46291,6 +46604,18 @@ export declare type RedisClient = {
|
|
46291
46604
|
/**
|
46292
46605
|
* Returns all field names in the hash stored at key.
|
46293
46606
|
* @arg {} key
|
46607
|
+
* @example
|
46608
|
+
* ```ts
|
46609
|
+
* async function hKeysExample(context: Devvit.Context) {
|
46610
|
+
* await context.redis.hSet("prices", {
|
46611
|
+
* "chair": "48",
|
46612
|
+
* "desk": "95",
|
46613
|
+
* "whiteboard": "23"
|
46614
|
+
* });
|
46615
|
+
* const keys : string[] = await context.redis.hKeys("prices");
|
46616
|
+
* console.log("Keys: " + keys);
|
46617
|
+
* }
|
46618
|
+
* ```
|
46294
46619
|
*/
|
46295
46620
|
hKeys(key: string): Promise<string[]>;
|
46296
46621
|
/**
|
@@ -46310,6 +46635,13 @@ export declare type RedisClient = {
|
|
46310
46635
|
* @arg {} field
|
46311
46636
|
* @arg {} value
|
46312
46637
|
* @returns value of key after the increment
|
46638
|
+
* @example
|
46639
|
+
* ```ts
|
46640
|
+
* async function hIncrByExample(context: Devvit.Context) {
|
46641
|
+
* await context.redis.hSet("user123", { "karma": "100" });
|
46642
|
+
* await context.redis.hIncrBy("user123", "karma", 5);
|
46643
|
+
* }
|
46644
|
+
* ```
|
46313
46645
|
*/
|
46314
46646
|
hIncrBy(key: string, field: string, value: number): Promise<number>;
|
46315
46647
|
/**
|
@@ -46323,6 +46655,19 @@ export declare type RedisClient = {
|
|
46323
46655
|
* Returns the number of fields contained in the hash stored at key.
|
46324
46656
|
* @arg {} key
|
46325
46657
|
* @returns the number of fields in the hash, or 0 when the key does not exist.
|
46658
|
+
* @example
|
46659
|
+
* ```ts
|
46660
|
+
* async function hLenExample(context: Devvit.Context) {
|
46661
|
+
* await context.redis.hSet("supplies", {
|
46662
|
+
* "paperclips": "25",
|
46663
|
+
* "pencils": "10",
|
46664
|
+
* "erasers": "5",
|
46665
|
+
* "pens": "7"
|
46666
|
+
* });
|
46667
|
+
* const numberOfFields : number = await context.redis.hLen("supplies");
|
46668
|
+
* console.log("Number of fields: " + numberOfFields);
|
46669
|
+
* }
|
46670
|
+
* ```
|
46326
46671
|
*/
|
46327
46672
|
hLen(key: string): Promise<number>;
|
46328
46673
|
/**
|
@@ -66188,24 +66533,96 @@ export declare type TxClientLike = {
|
|
66188
66533
|
* Executes all previously queued commands in a transaction and
|
66189
66534
|
* restores the connection state to normal. https://redis.io/commands/exec/
|
66190
66535
|
* @returns array, each element being the reply to each of the commands in the atomic transaction.
|
66536
|
+
* @example
|
66537
|
+
* ```ts
|
66538
|
+
* async function execExample(context: Devvit.Context) {
|
66539
|
+
* await context.redis.set("karma", "32");
|
66540
|
+
*
|
66541
|
+
* const txn = await context.redis.watch("quantity");
|
66542
|
+
*
|
66543
|
+
* await txn.multi(); // Begin a transaction
|
66544
|
+
* await txn.incrBy("karma", 10);
|
66545
|
+
* await txn.exec(); // Execute the commands in the transaction
|
66546
|
+
* }
|
66547
|
+
* ```
|
66191
66548
|
*/
|
66192
66549
|
exec(): Promise<any[]>;
|
66193
66550
|
/**
|
66194
66551
|
* Marks the start of a transaction block. Subsequent commands will be
|
66195
66552
|
* queued for atomic execution using EXEC. https://redis.io/commands/multi/
|
66553
|
+
* @example
|
66554
|
+
* ```ts
|
66555
|
+
* async function multiExample(context: Devvit.Context) {
|
66556
|
+
* await context.redis.set("karma", "32");
|
66557
|
+
*
|
66558
|
+
* const txn = await context.redis.watch("quantity");
|
66559
|
+
*
|
66560
|
+
* await txn.multi(); // Begin a transaction
|
66561
|
+
* await txn.incrBy("karma", 10);
|
66562
|
+
* await txn.exec(); // Execute the commands in the transaction
|
66563
|
+
* }
|
66564
|
+
* ```
|
66196
66565
|
*/
|
66197
66566
|
multi(): Promise<void>;
|
66567
|
+
/**
|
66568
|
+
* Flushes all previously queued commands in a transaction and restores the connection state to normal.
|
66569
|
+
* If WATCH was used, DISCARD unwatches all keys watched by the connection. https://redis.io/docs/latest/commands/discard/
|
66570
|
+
* @example
|
66571
|
+
* ```ts
|
66572
|
+
* async function discardExample(context: Devvit.Context) {
|
66573
|
+
* await context.redis.set("price", "25");
|
66574
|
+
*
|
66575
|
+
* const txn = await context.redis.watch("price");
|
66576
|
+
*
|
66577
|
+
* await txn.multi(); // Begin a transaction
|
66578
|
+
* await txn.incrBy("price", 5);
|
66579
|
+
* await txn.discard(); // Discard the commands in the transaction
|
66580
|
+
* }
|
66581
|
+
* ```
|
66582
|
+
*/
|
66198
66583
|
discard(): Promise<void>;
|
66199
66584
|
/**
|
66200
66585
|
* Marks the given keys to be watched for conditional execution of a transaction.
|
66201
66586
|
* https://redis.io/commands/watch/
|
66202
66587
|
* @arg {} keys - given keys to be watched
|
66588
|
+
* @example
|
66589
|
+
* ```ts
|
66590
|
+
* async function watchExample(context: Devvit.Context) {
|
66591
|
+
* await context.redis.set("karma", "32");
|
66592
|
+
*
|
66593
|
+
* const txn = await context.redis.watch("quantity");
|
66594
|
+
*
|
66595
|
+
* await txn.multi(); // Begin a transaction
|
66596
|
+
* await txn.incrBy("karma", 10);
|
66597
|
+
* await txn.exec(); // Execute the commands in the transaction
|
66598
|
+
* }
|
66599
|
+
* ```
|
66203
66600
|
*/
|
66204
66601
|
watch(...keys: string[]): Promise<TxClientLike>;
|
66205
66602
|
/**
|
66206
66603
|
* Flushes all the previously watched keys for a transaction.
|
66207
66604
|
* If you call EXEC or DISCARD, there's no need to manually call UNWATCH.
|
66208
66605
|
* https://redis.io/commands/unwatch/
|
66606
|
+
* @example
|
66607
|
+
* ```ts
|
66608
|
+
* async function unwatchExample(context: Devvit.Context) {
|
66609
|
+
* await context.redis.set("gold", "50");
|
66610
|
+
*
|
66611
|
+
* const txn = await context.redis.watch("gold");
|
66612
|
+
*
|
66613
|
+
* await txn.multi(); // Begin a transaction
|
66614
|
+
* await txn.incrBy("gold", 30);
|
66615
|
+
* await txn.unwatch(); // Unwatch "gold"
|
66616
|
+
*
|
66617
|
+
* // Now that "gold" has been unwatched, we can increment its value
|
66618
|
+
* // outside the transaction without canceling the transaction
|
66619
|
+
* await context.redis.incrBy("gold", -20);
|
66620
|
+
*
|
66621
|
+
* await txn.exec(); // Execute the commands in the transaction
|
66622
|
+
*
|
66623
|
+
* console.log("Gold value: " + await context.redis.get("gold")); // The value of 'gold' should be 50 + 30 - 20 = 60
|
66624
|
+
* }
|
66625
|
+
* ```
|
66209
66626
|
*/
|
66210
66627
|
unwatch(): Promise<TxClientLike>;
|
66211
66628
|
/**
|
@@ -66213,6 +66630,14 @@ export declare type TxClientLike = {
|
|
66213
66630
|
* https://redis.io/commands/get/
|
66214
66631
|
* @arg {} key
|
66215
66632
|
* @returns value of key or null when key does not exist.
|
66633
|
+
* @example
|
66634
|
+
* ```ts
|
66635
|
+
* async function getExample(context: Devvit.Context) {
|
66636
|
+
* await context.redis.set("quantity", "5");
|
66637
|
+
* const quantity : string | undefined = await context.redis.get("quantity");
|
66638
|
+
* console.log("Quantity: " + quantity);
|
66639
|
+
* }
|
66640
|
+
* ```
|
66216
66641
|
*/
|
66217
66642
|
get(key: string): Promise<TxClientLike>;
|
66218
66643
|
/**
|
@@ -66221,12 +66646,25 @@ export declare type TxClientLike = {
|
|
66221
66646
|
* @arg {} key
|
66222
66647
|
* @arg {} value
|
66223
66648
|
* @arg {} options
|
66649
|
+
* @example
|
66650
|
+
* ```ts
|
66651
|
+
* async function setExample(context: Devvit.Context) {
|
66652
|
+
* await context.redis.set("quantity", "5");
|
66653
|
+
* }
|
66654
|
+
* ```
|
66224
66655
|
*/
|
66225
66656
|
set(key: string, value: string, options?: SetOptions): Promise<TxClientLike>;
|
66226
66657
|
/**
|
66227
66658
|
* Removes the specified keys. A key is ignored if it does not exist.
|
66228
66659
|
* https://redis.io/commands/del/
|
66229
66660
|
* @arg {} keys
|
66661
|
+
* @example
|
66662
|
+
* ```ts
|
66663
|
+
* async function delExample(context: Devvit.Context) {
|
66664
|
+
* await context.redis.set("quantity", "5");
|
66665
|
+
* await context.redis.del("quantity");
|
66666
|
+
* }
|
66667
|
+
* ```
|
66230
66668
|
*/
|
66231
66669
|
del(...keys: string[]): Promise<TxClientLike>;
|
66232
66670
|
/**
|
@@ -66234,6 +66672,14 @@ export declare type TxClientLike = {
|
|
66234
66672
|
* https://redis.io/commands/incrby/
|
66235
66673
|
* @arg {} key
|
66236
66674
|
* @arg {} value
|
66675
|
+
* @example
|
66676
|
+
* ```ts
|
66677
|
+
* async function incrByExample(context: Devvit.Context) {
|
66678
|
+
* await context.redis.set("totalPoints", "53")
|
66679
|
+
* const updatedPoints : number = await context.redis.incrBy("totalPoints", 100);
|
66680
|
+
* console.log("Updated points: " + updatedPoints);
|
66681
|
+
* }
|
66682
|
+
* ```
|
66237
66683
|
*/
|
66238
66684
|
incrBy(key: string, value: number): Promise<TxClientLike>;
|
66239
66685
|
/**
|
@@ -66241,6 +66687,14 @@ export declare type TxClientLike = {
|
|
66241
66687
|
* https://redis.io/commands/type/
|
66242
66688
|
* @arg {} key
|
66243
66689
|
* @returns string representation of the type
|
66690
|
+
* @example
|
66691
|
+
* ```ts
|
66692
|
+
* async function typeExample(context: Devvit.Context) {
|
66693
|
+
* await context.redis.set("quantity", "5");
|
66694
|
+
* const type : string = await context.redis.type("quantity");
|
66695
|
+
* console.log("Key type: " + type);
|
66696
|
+
* }
|
66697
|
+
* ```
|
66244
66698
|
*/
|
66245
66699
|
type(key: string): Promise<TxClientLike>;
|
66246
66700
|
/**
|
@@ -66251,6 +66705,14 @@ export declare type TxClientLike = {
|
|
66251
66705
|
* @arg {} start
|
66252
66706
|
* @arg {} end
|
66253
66707
|
* @returns substring determined by offsets [start, end]
|
66708
|
+
* @example
|
66709
|
+
* ```ts
|
66710
|
+
* async function getRangeExample(context: Devvit.Context) {
|
66711
|
+
* await context.redis.set("word", "tacocat");
|
66712
|
+
* const range : string = await context.redis.getRange("word", 0, 3)
|
66713
|
+
* console.log("Range from index 0 to 3: " + range);
|
66714
|
+
* }
|
66715
|
+
* ```
|
66254
66716
|
*/
|
66255
66717
|
getRange(key: string, start: number, end: number): Promise<TxClientLike>;
|
66256
66718
|
/**
|
@@ -66260,6 +66722,13 @@ export declare type TxClientLike = {
|
|
66260
66722
|
* @arg {} key
|
66261
66723
|
* @arg {} offset
|
66262
66724
|
* @returns length of the string after it was modified by the command
|
66725
|
+
* @example
|
66726
|
+
* ```ts
|
66727
|
+
* async function setRangeExample(context: Devvit.Context) {
|
66728
|
+
* await context.redis.set("word", "tacocat");
|
66729
|
+
* await context.redis.setRange("word", 0, "blue");
|
66730
|
+
* }
|
66731
|
+
* ```
|
66263
66732
|
*/
|
66264
66733
|
setRange(key: string, offset: number, value: string): Promise<TxClientLike>;
|
66265
66734
|
/**
|
@@ -66277,6 +66746,14 @@ export declare type TxClientLike = {
|
|
66277
66746
|
* https://redis.io/commands/strlen/
|
66278
66747
|
* @arg {} key
|
66279
66748
|
* @returns length of the string stored at key
|
66749
|
+
* @example
|
66750
|
+
* ```ts
|
66751
|
+
* async function strLenExample(context: Devvit.Context) {
|
66752
|
+
* await context.redis.set("word", "tacocat");
|
66753
|
+
* const length : number = await context.redis.strLen("word");
|
66754
|
+
* console.log("Length of word: " + length);
|
66755
|
+
* }
|
66756
|
+
* ```
|
66280
66757
|
*/
|
66281
66758
|
strLen(key: string): Promise<TxClientLike>;
|
66282
66759
|
/**
|
@@ -66292,6 +66769,16 @@ export declare type TxClientLike = {
|
|
66292
66769
|
* https://redis.io/commands/mget/
|
66293
66770
|
* @arg {} keys
|
66294
66771
|
* @returns list of values at the specified keys
|
66772
|
+
* @example
|
66773
|
+
* ```ts
|
66774
|
+
* async function mGetExample(context: Devvit.Context) {
|
66775
|
+
* await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
|
66776
|
+
* const result : (string | null)[] = await context.redis.mGet(["name", "occupation"]);
|
66777
|
+
* result.forEach(x => {
|
66778
|
+
* console.log(x);
|
66779
|
+
* });
|
66780
|
+
* }
|
66781
|
+
* ```
|
66295
66782
|
*/
|
66296
66783
|
mGet(keys: string[]): Promise<TxClientLike>;
|
66297
66784
|
/**
|
@@ -66307,6 +66794,12 @@ export declare type TxClientLike = {
|
|
66307
66794
|
* Sets the given keys to their respective values.
|
66308
66795
|
* https://redis.io/commands/mset/
|
66309
66796
|
* @arg {} keyValues
|
66797
|
+
* @example
|
66798
|
+
* ```ts
|
66799
|
+
* async function mSetExample(context: Devvit.Context) {
|
66800
|
+
* await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
|
66801
|
+
* }
|
66802
|
+
* ```
|
66310
66803
|
*/
|
66311
66804
|
mSet(keyValues: {
|
66312
66805
|
[key: string]: string;
|
@@ -66316,6 +66809,13 @@ export declare type TxClientLike = {
|
|
66316
66809
|
* https://redis.io/commands/expire/
|
66317
66810
|
* @arg {} key
|
66318
66811
|
* @arg {} seconds
|
66812
|
+
* @example
|
66813
|
+
* ```ts
|
66814
|
+
* async function expireExample(context: Devvit.Context) {
|
66815
|
+
* await context.redis.set("product", "milk");
|
66816
|
+
* await context.redis.expire("product", 60); // Set the product to expire in 60 seconds
|
66817
|
+
* }
|
66818
|
+
* ```
|
66319
66819
|
*/
|
66320
66820
|
expire(key: string, seconds: number): Promise<TxClientLike>;
|
66321
66821
|
/**
|
@@ -66323,6 +66823,12 @@ export declare type TxClientLike = {
|
|
66323
66823
|
* https://redis.io/commands/expiretime/
|
66324
66824
|
* @arg {} key
|
66325
66825
|
* @returns expiration Unix timestamp in seconds, or a negative value in order to signal an error
|
66826
|
+
* @example
|
66827
|
+
* async function expireTimeExample(context: Devvit.Context) {
|
66828
|
+
* await context.redis.set("product", "milk");
|
66829
|
+
* const expireTime : number = await context.redis.expireTime("product");
|
66830
|
+
* console.log("Expire time: " + expireTime);
|
66831
|
+
* }
|
66326
66832
|
*/
|
66327
66833
|
expireTime(key: string): Promise<TxClientLike>;
|
66328
66834
|
/**
|
@@ -66330,6 +66836,18 @@ export declare type TxClientLike = {
|
|
66330
66836
|
* https://redis.io/commands/zadd/
|
66331
66837
|
* @arg {} key
|
66332
66838
|
* @returns number of elements added to the sorted set
|
66839
|
+
* @example
|
66840
|
+
* ```ts
|
66841
|
+
* async function zAddExample(context: Devvit.Context) {
|
66842
|
+
* const numMembersAdded : number = await context.redis.zAdd("leaderboard",
|
66843
|
+
* {member: "louis", score: 37},
|
66844
|
+
* {member: "fernando", score: 10},
|
66845
|
+
* {member: "caesar", score: 20},
|
66846
|
+
* {member: "alexander", score: 25},
|
66847
|
+
* );
|
66848
|
+
* console.log("Number of members added: " + numMembersAdded);
|
66849
|
+
* }
|
66850
|
+
* ```
|
66333
66851
|
*/
|
66334
66852
|
zAdd(key: string, ...members: ZMember[]): Promise<TxClientLike>;
|
66335
66853
|
/**
|
@@ -66337,6 +66855,19 @@ export declare type TxClientLike = {
|
|
66337
66855
|
* https://redis.io/commands/zcard/
|
66338
66856
|
* @arg {} key
|
66339
66857
|
* @returns cardinality of the sorted set
|
66858
|
+
* @example
|
66859
|
+
* ```ts
|
66860
|
+
* async function zCardExample(context: Devvit.Context) {
|
66861
|
+
* await context.redis.zAdd("leaderboard",
|
66862
|
+
* {member: "louis", score: 37},
|
66863
|
+
* {member: "fernando", score: 10},
|
66864
|
+
* {member: "caesar", score: 20},
|
66865
|
+
* {member: "alexander", score: 25},
|
66866
|
+
* );
|
66867
|
+
* const cardinality : number = await context.redis.zCard("leaderboard");
|
66868
|
+
* console.log("Cardinality: " + cardinality);
|
66869
|
+
* }
|
66870
|
+
* ```
|
66340
66871
|
*/
|
66341
66872
|
zCard(key: string): Promise<TxClientLike>;
|
66342
66873
|
/**
|
@@ -66346,6 +66877,19 @@ export declare type TxClientLike = {
|
|
66346
66877
|
* @arg {} member
|
66347
66878
|
* @arg {} value
|
66348
66879
|
* @returns the new score of member as a double precision floating point number
|
66880
|
+
* @example
|
66881
|
+
* ```ts
|
66882
|
+
* async function zIncrByExample(context: Devvit.Context) {
|
66883
|
+
* await context.redis.zAdd("animals",
|
66884
|
+
* {member: "zebra", score: 92},
|
66885
|
+
* {member: "cat", score: 100},
|
66886
|
+
* {member: "dog", score: 95},
|
66887
|
+
* {member: "elephant", score: 97}
|
66888
|
+
* );
|
66889
|
+
* const updatedScore : number = await context.redis.zIncrBy("animals", "dog", 10);
|
66890
|
+
* console.log("Dog's updated score: " + updatedScore);
|
66891
|
+
* }
|
66892
|
+
* ```
|
66349
66893
|
*/
|
66350
66894
|
zIncrBy(key: string, member: string, value: number): Promise<TxClientLike>;
|
66351
66895
|
/**
|
@@ -66355,6 +66899,19 @@ export declare type TxClientLike = {
|
|
66355
66899
|
* @arg {} member
|
66356
66900
|
* @returns rank of the member. The rank (or index) is 0-based
|
66357
66901
|
* which means that the member with the lowest score has rank 0
|
66902
|
+
* @example
|
66903
|
+
* ```ts
|
66904
|
+
* async function zRankExample(context: Devvit.Context) {
|
66905
|
+
* await context.redis.zAdd("animals",
|
66906
|
+
* {member: "zebra", score: 92},
|
66907
|
+
* {member: "cat", score: 100},
|
66908
|
+
* {member: "dog", score: 95},
|
66909
|
+
* {member: "elephant", score: 97}
|
66910
|
+
* );
|
66911
|
+
* const rank : number = await context.redis.zRank("animals", "dog");
|
66912
|
+
* console.log("Dog's rank: " + rank);
|
66913
|
+
* }
|
66914
|
+
* ```
|
66358
66915
|
*/
|
66359
66916
|
zRank(key: string, member: string): Promise<TxClientLike>;
|
66360
66917
|
/**
|
@@ -66363,6 +66920,19 @@ export declare type TxClientLike = {
|
|
66363
66920
|
* @arg {} key
|
66364
66921
|
* @arg {} member
|
66365
66922
|
* @returns the score of the member (a double-precision floating point number).
|
66923
|
+
* @example
|
66924
|
+
* ```ts
|
66925
|
+
* async function zScoreExample(context: Devvit.Context) {
|
66926
|
+
* await context.redis.zAdd("leaderboard",
|
66927
|
+
* {member: "louis", score: 37},
|
66928
|
+
* {member: "fernando", score: 10},
|
66929
|
+
* {member: "caesar", score: 20},
|
66930
|
+
* {member: "alexander", score: 25},
|
66931
|
+
* );
|
66932
|
+
* const score : number = await context.redis.zScore("leaderboard", "caesar");
|
66933
|
+
* console.log("Caesar's score: " + score);
|
66934
|
+
* }
|
66935
|
+
* ```
|
66366
66936
|
*/
|
66367
66937
|
zScore(key: string, member: string): Promise<TxClientLike>;
|
66368
66938
|
/**
|
@@ -66371,6 +66941,20 @@ export declare type TxClientLike = {
|
|
66371
66941
|
* @arg {} cursor
|
66372
66942
|
* @arg {} pattern
|
66373
66943
|
* @arg {} count
|
66944
|
+
* @example
|
66945
|
+
* ```ts
|
66946
|
+
* async function zScanExample(context: Devvit.Context) {
|
66947
|
+
* await context.redis.zAdd("fruits",
|
66948
|
+
* {member: "kiwi", score: 0},
|
66949
|
+
* {member: "mango", score: 0},
|
66950
|
+
* {member: "banana", score: 0},
|
66951
|
+
* {member: "orange", score: 0},
|
66952
|
+
* {member: "apple", score: 0},
|
66953
|
+
* );
|
66954
|
+
* const zScanResponse = await context.redis.zScan("fruits", 0);
|
66955
|
+
* console.log("zScanResponse: " + JSON.stringify(zScanResponse));
|
66956
|
+
* }
|
66957
|
+
* ```
|
66374
66958
|
*/
|
66375
66959
|
zScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
|
66376
66960
|
/**
|
@@ -66381,6 +66965,24 @@ export declare type TxClientLike = {
|
|
66381
66965
|
* @arg {} stop
|
66382
66966
|
* @arg {} options
|
66383
66967
|
* @returns list of elements in the specified range
|
66968
|
+
* @example
|
66969
|
+
* ```ts
|
66970
|
+
* async function zRangeExample(context: Devvit.Context) {
|
66971
|
+
* await context.redis.zAdd("leaderboard",
|
66972
|
+
* {member: "louis", score: 37},
|
66973
|
+
* {member: "fernando", score: 10},
|
66974
|
+
* {member: "caesar", score: 20},
|
66975
|
+
* {member: "alexander", score: 25},
|
66976
|
+
* );
|
66977
|
+
*
|
66978
|
+
* // View elements with scores between 0 and 30 inclusive, sorted by score
|
66979
|
+
* const scores : {member : string, score : number}[] = await context.redis.zRange("leaderboard", 0, 30, { by: "score" });
|
66980
|
+
*
|
66981
|
+
* scores.forEach(x => {
|
66982
|
+
* console.log("Member: " + x.member, ", Score: " + x.score);
|
66983
|
+
* });
|
66984
|
+
* }
|
66985
|
+
* ```
|
66384
66986
|
*/
|
66385
66987
|
zRange(key: string, start: number | string, stop: number | string, options?: ZRangeOptions): Promise<TxClientLike>;
|
66386
66988
|
/**
|
@@ -66389,6 +66991,19 @@ export declare type TxClientLike = {
|
|
66389
66991
|
* @arg {} key
|
66390
66992
|
* @arg {} members
|
66391
66993
|
* @returns number of members removed from the sorted set
|
66994
|
+
* @example
|
66995
|
+
* ```ts
|
66996
|
+
* async function zRemExample(context: Devvit.Context) {
|
66997
|
+
* await context.redis.zAdd("leaderboard",
|
66998
|
+
* {member: "louis", score: 37},
|
66999
|
+
* {member: "fernando", score: 10},
|
67000
|
+
* {member: "caesar", score: 20},
|
67001
|
+
* {member: "alexander", score: 25},
|
67002
|
+
* );
|
67003
|
+
* const numberOfMembersRemoved : number = await context.redis.zRem("leaderboard", ["fernando", "alexander"]);
|
67004
|
+
* console.log("Number of members removed: " + numberOfMembersRemoved);
|
67005
|
+
* }
|
67006
|
+
* ```
|
66392
67007
|
*/
|
66393
67008
|
zRem(key: string, members: string[]): Promise<TxClientLike>;
|
66394
67009
|
/**
|
@@ -66399,6 +67014,23 @@ export declare type TxClientLike = {
|
|
66399
67014
|
* @arg {} min
|
66400
67015
|
* @arg {} max
|
66401
67016
|
* @returns number of members removed from the sorted set
|
67017
|
+
* @example
|
67018
|
+
* ```ts
|
67019
|
+
* async function zRemRangeByLexExample(context: Devvit.Context) {
|
67020
|
+
* await context.redis.zAdd("fruits",
|
67021
|
+
* {member: "kiwi", score: 0},
|
67022
|
+
* {member: "mango", score: 0},
|
67023
|
+
* {member: "banana", score: 0},
|
67024
|
+
* {member: "orange", score: 0},
|
67025
|
+
* {member: "apple", score: 0},
|
67026
|
+
* );
|
67027
|
+
*
|
67028
|
+
* // Remove fruits alphabetically ordered between 'kiwi' inclusive and 'orange' exclusive
|
67029
|
+
* // Note: The symbols '[' and '(' indicate inclusive or exclusive, respectively. These must be included in the call to zRemRangeByLex().
|
67030
|
+
* const numFieldsRemoved : number = await context.redis.zRemRangeByLex("fruits", "[kiwi", "(orange");
|
67031
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
67032
|
+
* }
|
67033
|
+
* ```
|
66402
67034
|
*/
|
66403
67035
|
zRemRangeByLex(key: string, min: string, max: string): Promise<TxClientLike>;
|
66404
67036
|
/**
|
@@ -66408,6 +67040,22 @@ export declare type TxClientLike = {
|
|
66408
67040
|
* @arg {} start
|
66409
67041
|
* @arg {} stop
|
66410
67042
|
* @returns number of members removed from the sorted set
|
67043
|
+
* @example
|
67044
|
+
* ```
|
67045
|
+
* async function zRemRangeByRankExample(context: Devvit.Context) {
|
67046
|
+
* await context.redis.zAdd("fruits",
|
67047
|
+
* {member: "kiwi", score: 10},
|
67048
|
+
* {member: "mango", score: 20},
|
67049
|
+
* {member: "banana", score: 30},
|
67050
|
+
* {member: "orange", score: 40},
|
67051
|
+
* {member: "apple", score: 50},
|
67052
|
+
* );
|
67053
|
+
|
67054
|
+
* // Remove fruits ranked 1 through 3 inclusive
|
67055
|
+
* const numFieldsRemoved : number = await context.redis.zRemRangeByRank("fruits", 1, 3);
|
67056
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
67057
|
+
* }
|
67058
|
+
* ```
|
66411
67059
|
*/
|
66412
67060
|
zRemRangeByRank(key: string, start: number, stop: number): Promise<TxClientLike>;
|
66413
67061
|
/**
|
@@ -66417,6 +67065,21 @@ export declare type TxClientLike = {
|
|
66417
67065
|
* @arg {} min
|
66418
67066
|
* @arg {} max
|
66419
67067
|
* @returns number of members removed from the sorted set
|
67068
|
+
* @example
|
67069
|
+
* ```ts
|
67070
|
+
* async function zRemRangeByScoreExample(context: Devvit.Context) {
|
67071
|
+
* await context.redis.zAdd("fruits",
|
67072
|
+
* {member: "kiwi", score: 10},
|
67073
|
+
* {member: "mango", score: 20},
|
67074
|
+
* {member: "banana", score: 30},
|
67075
|
+
* {member: "orange", score: 40},
|
67076
|
+
* {member: "apple", score: 50},
|
67077
|
+
* );
|
67078
|
+
* // Remove fruits scored between 30 and 50 inclusive
|
67079
|
+
* const numFieldsRemoved : number = await context.redis.zRemRangeByScore("fruits", 30, 50);
|
67080
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
67081
|
+
* }
|
67082
|
+
* ```
|
66420
67083
|
*/
|
66421
67084
|
zRemRangeByScore(key: string, min: number, max: number): Promise<TxClientLike>;
|
66422
67085
|
/**
|
@@ -66436,6 +67099,13 @@ export declare type TxClientLike = {
|
|
66436
67099
|
* @arg {} key
|
66437
67100
|
* @arg {} fieldValues
|
66438
67101
|
* @returns number of fields that were added
|
67102
|
+
* @example
|
67103
|
+
* ```ts
|
67104
|
+
* async function hSetExample(context: Devvit.Context) {
|
67105
|
+
* const numFieldsAdded = await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
|
67106
|
+
* console.log("Number of fields added: " + numFieldsAdded);
|
67107
|
+
* }
|
67108
|
+
* ```
|
66439
67109
|
*/
|
66440
67110
|
hSet(key: string, fieldValues: {
|
66441
67111
|
[field: string]: string;
|
@@ -66455,6 +67125,14 @@ export declare type TxClientLike = {
|
|
66455
67125
|
* @arg {} key
|
66456
67126
|
* @arg {} field
|
66457
67127
|
* @returns value associated with field
|
67128
|
+
* @example
|
67129
|
+
* ```ts
|
67130
|
+
* async function hGetExample(context: Devvit.Context) {
|
67131
|
+
* await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
|
67132
|
+
* const result : string | undefined = await context.redis.hGet("fruits", "orange");
|
67133
|
+
* console.log("Value of orange: " + result);
|
67134
|
+
* }
|
67135
|
+
* ```
|
66458
67136
|
*/
|
66459
67137
|
hGet(key: string, field: string): Promise<TxClientLike>;
|
66460
67138
|
/**
|
@@ -66470,6 +67148,22 @@ export declare type TxClientLike = {
|
|
66470
67148
|
* https://redis.io/commands/hgetall
|
66471
67149
|
* @arg {} key
|
66472
67150
|
* @returns a map of fields and their values stored in the hash,
|
67151
|
+
* @example
|
67152
|
+
* ```
|
67153
|
+
* async function hGetAllExample(context: Devvit.Context) {
|
67154
|
+
* await context.redis.hSet("groceryList", {
|
67155
|
+
* "eggs": "12",
|
67156
|
+
* "apples": "3",
|
67157
|
+
* "milk": "1"
|
67158
|
+
* });
|
67159
|
+
*
|
67160
|
+
* const record : Record<string, string> | undefined = await context.redis.hGetAll("groceryList");
|
67161
|
+
*
|
67162
|
+
* if (record != undefined) {
|
67163
|
+
* console.log("Eggs: " + record.eggs + ", Apples: " + record.apples + ", Milk: " + record.milk);
|
67164
|
+
* }
|
67165
|
+
* }
|
67166
|
+
* ```
|
66473
67167
|
*/
|
66474
67168
|
hGetAll(key: string): Promise<TxClientLike>;
|
66475
67169
|
/**
|
@@ -66487,6 +67181,14 @@ export declare type TxClientLike = {
|
|
66487
67181
|
* @arg {} key
|
66488
67182
|
* @arg {} fields
|
66489
67183
|
* @returns number of fields that were removed from the hash
|
67184
|
+
* @example
|
67185
|
+
* ```ts
|
67186
|
+
* async function hDelExample(context: Devvit.Context) {
|
67187
|
+
* await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
|
67188
|
+
* const numFieldsRemoved = await context.redis.hDel("fruits", ["apple", "kiwi"]);
|
67189
|
+
* console.log("Number of fields removed: " + numFieldsRemoved);
|
67190
|
+
* }
|
67191
|
+
* ```
|
66490
67192
|
*/
|
66491
67193
|
hDel(key: string, fields: string[]): Promise<TxClientLike>;
|
66492
67194
|
/**
|
@@ -66504,6 +67206,22 @@ export declare type TxClientLike = {
|
|
66504
67206
|
* @arg {} cursor
|
66505
67207
|
* @arg {} pattern
|
66506
67208
|
* @arg {} count
|
67209
|
+
* @example
|
67210
|
+
* ```ts
|
67211
|
+
* async function hScanExample(context: Devvit.Context) {
|
67212
|
+
* await context.redis.hSet("userInfo", {
|
67213
|
+
* "name": "Bob",
|
67214
|
+
* "startDate": "01-05-20",
|
67215
|
+
* "totalAwards": "12"
|
67216
|
+
* });
|
67217
|
+
*
|
67218
|
+
* const hScanResponse = await context.redis.hScan("userInfo", 0);
|
67219
|
+
*
|
67220
|
+
* hScanResponse.fieldValues.forEach(x => {
|
67221
|
+
* console.log("Field: '" + x.field + "', Value: '" + x.value + "'");
|
67222
|
+
* });
|
67223
|
+
* }
|
67224
|
+
* ```
|
66507
67225
|
*/
|
66508
67226
|
hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
|
66509
67227
|
/**
|
@@ -66515,6 +67233,18 @@ export declare type TxClientLike = {
|
|
66515
67233
|
/**
|
66516
67234
|
* Returns all field names in the hash stored at key.
|
66517
67235
|
* @arg {} key
|
67236
|
+
* @example
|
67237
|
+
* ```ts
|
67238
|
+
* async function hKeysExample(context: Devvit.Context) {
|
67239
|
+
* await context.redis.hSet("prices", {
|
67240
|
+
* "chair": "48",
|
67241
|
+
* "desk": "95",
|
67242
|
+
* "whiteboard": "23"
|
67243
|
+
* });
|
67244
|
+
* const keys : string[] = await context.redis.hKeys("prices");
|
67245
|
+
* console.log("Keys: " + keys);
|
67246
|
+
* }
|
67247
|
+
* ```
|
66518
67248
|
*/
|
66519
67249
|
hKeys(key: string): Promise<TxClientLike>;
|
66520
67250
|
/**
|
@@ -66534,6 +67264,13 @@ export declare type TxClientLike = {
|
|
66534
67264
|
* @arg {} field
|
66535
67265
|
* @arg {} value
|
66536
67266
|
* @returns value of key after the increment
|
67267
|
+
* @example
|
67268
|
+
* ```ts
|
67269
|
+
* async function hIncrByExample(context: Devvit.Context) {
|
67270
|
+
* await context.redis.hSet("user123", { "karma": "100" });
|
67271
|
+
* await context.redis.hIncrBy("user123", "karma", 5);
|
67272
|
+
* }
|
67273
|
+
* ```
|
66537
67274
|
*/
|
66538
67275
|
hIncrBy(key: string, field: string, value: number): Promise<TxClientLike>;
|
66539
67276
|
/**
|
@@ -66547,6 +67284,19 @@ export declare type TxClientLike = {
|
|
66547
67284
|
* Returns the number of fields contained in the hash stored at key.
|
66548
67285
|
* @arg {} key
|
66549
67286
|
* @returns the number of fields in the hash, or 0 when the key does not exist.
|
67287
|
+
* @example
|
67288
|
+
* ```ts
|
67289
|
+
* async function hLenExample(context: Devvit.Context) {
|
67290
|
+
* await context.redis.hSet("supplies", {
|
67291
|
+
* "paperclips": "25",
|
67292
|
+
* "pencils": "10",
|
67293
|
+
* "erasers": "5",
|
67294
|
+
* "pens": "7"
|
67295
|
+
* });
|
67296
|
+
* const numberOfFields : number = await context.redis.hLen("supplies");
|
67297
|
+
* console.log("Number of fields: " + numberOfFields);
|
67298
|
+
* }
|
67299
|
+
* ```
|
66550
67300
|
*/
|
66551
67301
|
hLen(key: string): Promise<TxClientLike>;
|
66552
67302
|
};
|