@devvit/public-api 0.10.24-next-2024-08-08-2f3eace0d.0 → 0.10.24-next-2024-08-08-4d6152bee.0
Sign up to get free protection for your applications and to get access to all the features.
- package/apis/reddit/RedditAPIClient.d.ts +8 -4
- package/apis/reddit/RedditAPIClient.d.ts.map +1 -1
- package/apis/reddit/RedditAPIClient.js +7 -3
- package/apis/reddit/models/Comment.d.ts +4 -2
- package/apis/reddit/models/Comment.d.ts.map +1 -1
- package/apis/reddit/models/Comment.js +12 -2
- package/apis/reddit/models/ModNote.d.ts +1 -1
- package/apis/reddit/models/ModNote.d.ts.map +1 -1
- package/apis/reddit/models/Post.d.ts +3 -1
- package/apis/reddit/models/Post.d.ts.map +1 -1
- package/apis/reddit/models/Post.js +12 -2
- package/apis/reddit/models/User.d.ts +56 -0
- package/apis/reddit/models/User.d.ts.map +1 -1
- package/apis/reddit/models/User.js +54 -7
- package/apis/redis/RedisClient.d.ts +30 -0
- package/apis/redis/RedisClient.d.ts.map +1 -1
- package/apis/redis/RedisClient.js +66 -0
- package/devvit/internals/helpers/settingsUtils.d.ts +4 -1
- package/devvit/internals/helpers/settingsUtils.d.ts.map +1 -1
- package/devvit/internals/helpers/settingsUtils.js +10 -7
- package/devvit/internals/helpers/settingsUtils.test.d.ts.map +1 -0
- package/meta.json +16 -16
- package/meta.min.json +17 -16
- package/package.json +7 -7
- package/public-api.d.ts +268 -7
- package/public-api.iife.js +169 -23
- package/public-api.min.js +5 -5
- package/public-api.min.js.map +3 -3
- package/types/redis.d.ts +195 -0
- package/types/redis.d.ts.map +1 -1
package/public-api.d.ts
CHANGED
@@ -4768,6 +4768,8 @@ export declare class Comment {
|
|
4768
4768
|
get stickied(): boolean;
|
4769
4769
|
get removed(): boolean;
|
4770
4770
|
get approved(): boolean;
|
4771
|
+
get approvedAtUtc(): number;
|
4772
|
+
get bannedAtUtc(): number;
|
4771
4773
|
get spam(): boolean;
|
4772
4774
|
get edited(): boolean;
|
4773
4775
|
get numReports(): number;
|
@@ -4792,7 +4794,7 @@ export declare class Comment {
|
|
4792
4794
|
lock(): Promise<void>;
|
4793
4795
|
unlock(): Promise<void>;
|
4794
4796
|
reply(options: ReplyToCommentOptions): Promise<Comment>;
|
4795
|
-
getAuthor(): Promise<User>;
|
4797
|
+
getAuthor(): Promise<User | undefined>;
|
4796
4798
|
distinguish(makeSticky?: boolean): Promise<void>;
|
4797
4799
|
distinguishAsAdmin(makeSticky?: boolean): Promise<void>;
|
4798
4800
|
undistinguish(): Promise<void>;
|
@@ -6372,7 +6374,7 @@ export declare type CreateFlairTemplateOptions = {
|
|
6372
6374
|
};
|
6373
6375
|
|
6374
6376
|
export declare type CreateModNoteOptions = Prettify<PostNotesRequest & {
|
6375
|
-
redditId
|
6377
|
+
redditId?: T1ID | T3ID;
|
6376
6378
|
label: UserNoteLabel;
|
6377
6379
|
}>;
|
6378
6380
|
|
@@ -39639,6 +39641,8 @@ export declare class Post {
|
|
39639
39641
|
get numberOfComments(): number;
|
39640
39642
|
get numberOfReports(): number;
|
39641
39643
|
get approved(): boolean;
|
39644
|
+
get approvedAtUtc(): number;
|
39645
|
+
get bannedAtUtc(): number;
|
39642
39646
|
get spam(): boolean;
|
39643
39647
|
get stickied(): boolean;
|
39644
39648
|
get removed(): boolean;
|
@@ -39708,7 +39712,7 @@ export declare class Post {
|
|
39708
39712
|
undistinguish(): Promise<void>;
|
39709
39713
|
ignoreReports(): Promise<void>;
|
39710
39714
|
unignoreReports(): Promise<void>;
|
39711
|
-
getAuthor(): Promise<User>;
|
39715
|
+
getAuthor(): Promise<User | undefined>;
|
39712
39716
|
crosspost(options: Omit<CrosspostOptions, 'postId'>): Promise<Post>;
|
39713
39717
|
/**
|
39714
39718
|
* Add a mod note for why the post was removed
|
@@ -43541,7 +43545,7 @@ export declare class RedditAPIClient {
|
|
43541
43545
|
* const user = await reddit.getUserById('t2_1qjpg');
|
43542
43546
|
* ```
|
43543
43547
|
*/
|
43544
|
-
getUserById(id: string): Promise<User>;
|
43548
|
+
getUserById(id: string): Promise<User | undefined>;
|
43545
43549
|
getCollectionById(collectionId: string): Promise<PostCollection>;
|
43546
43550
|
createCollection(options: CreateCollectionInput): Promise<PostCollection>;
|
43547
43551
|
getCollectionsForSubreddit(subredditId: string): Promise<PostCollection[]>;
|
@@ -43549,13 +43553,17 @@ export declare class RedditAPIClient {
|
|
43549
43553
|
* Gets a {@link User} object by username
|
43550
43554
|
*
|
43551
43555
|
* @param username - The username of the user omitting the u/. e.g. 'devvit'
|
43552
|
-
* @returns A Promise that resolves to a User object
|
43556
|
+
* @returns A Promise that resolves to a User object or undefined if user is
|
43557
|
+
* not found (user doesn't exist, account suspended, etc).
|
43553
43558
|
* @example
|
43554
43559
|
* ```ts
|
43555
43560
|
* const user = await reddit.getUserByUsername('devvit');
|
43561
|
+
* if (user) {
|
43562
|
+
* console.log(user)
|
43563
|
+
* }
|
43556
43564
|
* ```
|
43557
43565
|
*/
|
43558
|
-
getUserByUsername(username: string): Promise<User>;
|
43566
|
+
getUserByUsername(username: string): Promise<User | undefined>;
|
43559
43567
|
/**
|
43560
43568
|
* Get the current calling user based on the provided metadata.
|
43561
43569
|
* Resolves to undefined for logged-out custom post renders.
|
@@ -43990,7 +43998,7 @@ export declare class RedditAPIClient {
|
|
43990
43998
|
* @param options - Options for the request
|
43991
43999
|
* @param options.subreddit - The name of the subreddit to add the mod note to. e.g. 'memes'
|
43992
44000
|
* @param options.user - The username of the user to add the mod note to. e.g. 'spez'
|
43993
|
-
* @param options.redditId - The ID of the comment or post to add the mod note to. e.g. 't3_1234'
|
44001
|
+
* @param options.redditId - (optional) The ID of the comment or post to add the mod note to. e.g. 't3_1234'
|
43994
44002
|
* @param options.label - The label of the mod note. e.g. 'SPAM_WARNING'
|
43995
44003
|
* @param options.note - The text of the mod note.
|
43996
44004
|
* @returns A Promise that resolves if the mod note was successfully added.
|
@@ -46288,10 +46296,19 @@ export declare type RedisClient = {
|
|
46288
46296
|
* Returns the length of the string value stored at key.
|
46289
46297
|
* An error is returned when key holds a non-string value.
|
46290
46298
|
* https://redis.io/commands/strlen/
|
46299
|
+
* @deprecated Use {@link RedisClient.strLen} instead.
|
46291
46300
|
* @arg {} key
|
46292
46301
|
* @returns length of the string stored at key
|
46293
46302
|
*/
|
46294
46303
|
strlen(key: string): Promise<number>;
|
46304
|
+
/**
|
46305
|
+
* Returns the length of the string value stored at key.
|
46306
|
+
* An error is returned when key holds a non-string value.
|
46307
|
+
* https://redis.io/commands/strlen/
|
46308
|
+
* @arg {} key
|
46309
|
+
* @returns length of the string stored at key
|
46310
|
+
*/
|
46311
|
+
strLen(key: string): Promise<number>;
|
46295
46312
|
/**
|
46296
46313
|
* Increments the number stored at key by increment.
|
46297
46314
|
* https://redis.io/commands/incrby/
|
@@ -46303,18 +46320,35 @@ export declare type RedisClient = {
|
|
46303
46320
|
/**
|
46304
46321
|
* Returns the values of all specified keys.
|
46305
46322
|
* https://redis.io/commands/mget/
|
46323
|
+
* @deprecated Use {@link RedisClient.mGet} instead.
|
46306
46324
|
* @arg {} keys
|
46307
46325
|
* @returns list of values at the specified keys
|
46308
46326
|
*/
|
46309
46327
|
mget(keys: string[]): Promise<(string | null)[]>;
|
46328
|
+
/**
|
46329
|
+
* Returns the values of all specified keys.
|
46330
|
+
* https://redis.io/commands/mget/
|
46331
|
+
* @arg {} keys
|
46332
|
+
* @returns list of values at the specified keys
|
46333
|
+
*/
|
46334
|
+
mGet(keys: string[]): Promise<(string | null)[]>;
|
46310
46335
|
/**
|
46311
46336
|
* Sets the given keys to their respective values.
|
46312
46337
|
* https://redis.io/commands/mset/
|
46338
|
+
* @deprecated Use {@link RedisClient.mSet} instead.
|
46313
46339
|
* @arg {} keyValues
|
46314
46340
|
*/
|
46315
46341
|
mset(keyValues: {
|
46316
46342
|
[key: string]: string;
|
46317
46343
|
}): Promise<void>;
|
46344
|
+
/**
|
46345
|
+
* Sets the given keys to their respective values.
|
46346
|
+
* https://redis.io/commands/mset/
|
46347
|
+
* @arg {} keyValues
|
46348
|
+
*/
|
46349
|
+
mSet(keyValues: {
|
46350
|
+
[key: string]: string;
|
46351
|
+
}): Promise<void>;
|
46318
46352
|
/**
|
46319
46353
|
* Set a timeout on key.
|
46320
46354
|
* https://redis.io/commands/expire/
|
@@ -46429,6 +46463,7 @@ export declare type RedisClient = {
|
|
46429
46463
|
/**
|
46430
46464
|
* Sets the specified fields to their respective values in the hash stored at key.
|
46431
46465
|
* https://redis.io/commands/hset
|
46466
|
+
* @deprecated Use {@link RedisClient.hSet} instead.
|
46432
46467
|
* @arg {} key
|
46433
46468
|
* @arg {} fieldValues
|
46434
46469
|
* @returns number of fields that were added
|
@@ -46436,42 +46471,93 @@ export declare type RedisClient = {
|
|
46436
46471
|
hset(key: string, fieldValues: {
|
46437
46472
|
[field: string]: string;
|
46438
46473
|
}): Promise<number>;
|
46474
|
+
/**
|
46475
|
+
* Sets the specified fields to their respective values in the hash stored at key.
|
46476
|
+
* https://redis.io/commands/hset
|
46477
|
+
* @arg {} key
|
46478
|
+
* @arg {} fieldValues
|
46479
|
+
* @returns number of fields that were added
|
46480
|
+
*/
|
46481
|
+
hSet(key: string, fieldValues: {
|
46482
|
+
[field: string]: string;
|
46483
|
+
}): Promise<number>;
|
46439
46484
|
/**
|
46440
46485
|
* Returns the value associated with field in the hash stored at key.
|
46441
46486
|
* https://redis.io/commands/hget
|
46487
|
+
* @deprecated Use {@link RedisClient.hGet} instead.
|
46442
46488
|
* @arg {} key
|
46443
46489
|
* @arg {} field
|
46444
46490
|
* @returns value associated with field
|
46445
46491
|
*/
|
46446
46492
|
hget(key: string, field: string): Promise<string | undefined>;
|
46493
|
+
/**
|
46494
|
+
* Returns the value associated with field in the hash stored at key.
|
46495
|
+
* https://redis.io/commands/hget
|
46496
|
+
* @arg {} key
|
46497
|
+
* @arg {} field
|
46498
|
+
* @returns value associated with field
|
46499
|
+
*/
|
46500
|
+
hGet(key: string, field: string): Promise<string | undefined>;
|
46447
46501
|
/**
|
46448
46502
|
* Returns all fields and values of the hash stored at key
|
46449
46503
|
* https://redis.io/commands/hgetall
|
46504
|
+
* @deprecated Use {@link RedisClient.hGetAll} instead.
|
46450
46505
|
* @arg {} key
|
46451
46506
|
* @returns a map of fields and their values stored in the hash,
|
46452
46507
|
*/
|
46453
46508
|
hgetall(key: string): Promise<Record<string, string> | undefined>;
|
46509
|
+
/**
|
46510
|
+
* Returns all fields and values of the hash stored at key
|
46511
|
+
* https://redis.io/commands/hgetall
|
46512
|
+
* @arg {} key
|
46513
|
+
* @returns a map of fields and their values stored in the hash,
|
46514
|
+
*/
|
46515
|
+
hGetAll(key: string): Promise<Record<string, string> | undefined>;
|
46454
46516
|
/**
|
46455
46517
|
* Removes the specified fields from the hash stored at key.
|
46456
46518
|
* https://redis.io/commands/hdel/
|
46519
|
+
* @deprecated Use {@link RedisClient.hDel} instead.
|
46457
46520
|
* @arg {} key
|
46458
46521
|
* @arg {} fields
|
46459
46522
|
* @returns number of fields that were removed from the hash
|
46460
46523
|
*/
|
46461
46524
|
hdel(key: string, fields: string[]): Promise<number>;
|
46525
|
+
/**
|
46526
|
+
* Removes the specified fields from the hash stored at key.
|
46527
|
+
* https://redis.io/commands/hdel/
|
46528
|
+
* @arg {} key
|
46529
|
+
* @arg {} fields
|
46530
|
+
* @returns number of fields that were removed from the hash
|
46531
|
+
*/
|
46532
|
+
hDel(key: string, fields: string[]): Promise<number>;
|
46462
46533
|
/**
|
46463
46534
|
* Iterates fields of Hash types and their associated values.
|
46535
|
+
* @deprecated Use {@link RedisClient.hScan} instead.
|
46464
46536
|
* @arg {} key
|
46465
46537
|
* @arg {} cursor
|
46466
46538
|
* @arg {} pattern
|
46467
46539
|
* @arg {} count
|
46468
46540
|
*/
|
46469
46541
|
hscan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
|
46542
|
+
/**
|
46543
|
+
* Iterates fields of Hash types and their associated values.
|
46544
|
+
* @arg {} key
|
46545
|
+
* @arg {} cursor
|
46546
|
+
* @arg {} pattern
|
46547
|
+
* @arg {} count
|
46548
|
+
*/
|
46549
|
+
hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
|
46470
46550
|
/**
|
46471
46551
|
* Returns all field names in the hash stored at key.
|
46552
|
+
* @deprecated Use {@link RedisClient.hKeys} instead.
|
46472
46553
|
* @arg {} key
|
46473
46554
|
*/
|
46474
46555
|
hkeys(key: string): Promise<string[]>;
|
46556
|
+
/**
|
46557
|
+
* Returns all field names in the hash stored at key.
|
46558
|
+
* @arg {} key
|
46559
|
+
*/
|
46560
|
+
hKeys(key: string): Promise<string[]>;
|
46475
46561
|
/**
|
46476
46562
|
* Increments the number stored at field in the hash stored at key by increment.
|
46477
46563
|
* https://redis.io/commands/hincrby/
|
@@ -46481,12 +46567,29 @@ export declare type RedisClient = {
|
|
46481
46567
|
* @returns value of key after the increment
|
46482
46568
|
*/
|
46483
46569
|
hincrby(key: string, field: string, value: number): Promise<number>;
|
46570
|
+
/**
|
46571
|
+
* Increments the number stored at field in the hash stored at key by increment.
|
46572
|
+
* https://redis.io/commands/hincrby/
|
46573
|
+
* @deprecated Use {@link RedisClient.hIncrBy} instead.
|
46574
|
+
* @arg {} key
|
46575
|
+
* @arg {} field
|
46576
|
+
* @arg {} value
|
46577
|
+
* @returns value of key after the increment
|
46578
|
+
*/
|
46579
|
+
hIncrBy(key: string, field: string, value: number): Promise<number>;
|
46484
46580
|
/**
|
46485
46581
|
* Returns the number of fields contained in the hash stored at key.
|
46582
|
+
* @deprecated Use {@link RedisClient.hLen} instead.
|
46486
46583
|
* @arg {} key
|
46487
46584
|
* @returns the number of fields in the hash, or 0 when the key does not exist.
|
46488
46585
|
*/
|
46489
46586
|
hlen(key: string): Promise<number>;
|
46587
|
+
/**
|
46588
|
+
* Returns the number of fields contained in the hash stored at key.
|
46589
|
+
* @arg {} key
|
46590
|
+
* @returns the number of fields in the hash, or 0 when the key does not exist.
|
46591
|
+
*/
|
46592
|
+
hLen(key: string): Promise<number>;
|
46490
46593
|
/**
|
46491
46594
|
* Allows read/write operations to global keys in Redis
|
46492
46595
|
* Global redis enables apps to persist and access state across subreddit installations
|
@@ -49259,6 +49362,35 @@ declare const SnoozeReportsRequest: {
|
|
49259
49362
|
fromPartial(object: DeepPartial_2<SnoozeReportsRequest>): SnoozeReportsRequest;
|
49260
49363
|
};
|
49261
49364
|
|
49365
|
+
export declare const enum SocialLinkType {
|
49366
|
+
Custom = "CUSTOM",
|
49367
|
+
Reddit = "REDDIT",
|
49368
|
+
Instagram = "INSTAGRAM",
|
49369
|
+
Twitter = "TWITTER",
|
49370
|
+
Tiktok = "TIKTOK",
|
49371
|
+
Twitch = "TWITCH",
|
49372
|
+
Facebook = "FACEBOOK",
|
49373
|
+
Youtube = "YOUTUBE",
|
49374
|
+
Tumblr = "TUMBLR",
|
49375
|
+
Spotify = "SPOTIFY",
|
49376
|
+
Soundcloud = "SOUNDCLOUD",
|
49377
|
+
Beacons = "BEACONS",
|
49378
|
+
Linktree = "LINKTREE",
|
49379
|
+
Discord = "DISCORD",
|
49380
|
+
Venmo = "VENMO",
|
49381
|
+
CashApp = "CASH_APP",
|
49382
|
+
Patreon = "PATREON",
|
49383
|
+
Kofi = "KOFI",
|
49384
|
+
Paypal = "PAYPAL",
|
49385
|
+
Cameo = "CAMEO",
|
49386
|
+
Onlyfans = "ONLYFANS",
|
49387
|
+
Substack = "SUBSTACK",
|
49388
|
+
Kickstarter = "KICKSTARTER",
|
49389
|
+
Indiegogo = "INDIEGOGO",
|
49390
|
+
BuyMeACoffee = "BUY_ME_A_COFFEE",
|
49391
|
+
Shopify = "SHOPIFY"
|
49392
|
+
}
|
49393
|
+
|
49262
49394
|
/**
|
49263
49395
|
* Encapsulates information about the original source file from which a
|
49264
49396
|
* FileDescriptorProto was generated.
|
@@ -66094,6 +66226,11 @@ export declare type TxClientLike = {
|
|
66094
66226
|
* @arg {} keys - given keys to be watched
|
66095
66227
|
*/
|
66096
66228
|
watch(...keys: string[]): Promise<TxClientLike>;
|
66229
|
+
/**
|
66230
|
+
* Flushes all the previously watched keys for a transaction.
|
66231
|
+
* If you call EXEC or DISCARD, there's no need to manually call UNWATCH.
|
66232
|
+
* https://redis.io/commands/unwatch/
|
66233
|
+
*/
|
66097
66234
|
unwatch(): Promise<TxClientLike>;
|
66098
66235
|
/**
|
66099
66236
|
* Get the value of key. If the key does not exist the special value nil is returned.
|
@@ -66153,25 +66290,51 @@ export declare type TxClientLike = {
|
|
66153
66290
|
* Returns the length of the string value stored at key.
|
66154
66291
|
* An error is returned when key holds a non-string value.
|
66155
66292
|
* https://redis.io/commands/strlen/
|
66293
|
+
* @deprecated Use {@link TxClientLike.strLen} instead.
|
66156
66294
|
* @arg {} key
|
66157
66295
|
* @returns length of the string stored at key
|
66158
66296
|
*/
|
66159
66297
|
strlen(key: string): Promise<TxClientLike>;
|
66298
|
+
/**
|
66299
|
+
* Returns the length of the string value stored at key.
|
66300
|
+
* An error is returned when key holds a non-string value.
|
66301
|
+
* https://redis.io/commands/strlen/
|
66302
|
+
* @arg {} key
|
66303
|
+
* @returns length of the string stored at key
|
66304
|
+
*/
|
66305
|
+
strLen(key: string): Promise<TxClientLike>;
|
66160
66306
|
/**
|
66161
66307
|
* Returns the values of all specified keys.
|
66162
66308
|
* https://redis.io/commands/mget/
|
66309
|
+
* @deprecated Use {@link TxClientLike.mGet} instead.
|
66163
66310
|
* @arg {} keys
|
66164
66311
|
* @returns list of values at the specified keys
|
66165
66312
|
*/
|
66166
66313
|
mget(keys: string[]): Promise<TxClientLike>;
|
66314
|
+
/**
|
66315
|
+
* Returns the values of all specified keys.
|
66316
|
+
* https://redis.io/commands/mget/
|
66317
|
+
* @arg {} keys
|
66318
|
+
* @returns list of values at the specified keys
|
66319
|
+
*/
|
66320
|
+
mGet(keys: string[]): Promise<TxClientLike>;
|
66167
66321
|
/**
|
66168
66322
|
* Sets the given keys to their respective values.
|
66169
66323
|
* https://redis.io/commands/mset/
|
66324
|
+
* @deprecated Use {@link TxClientLike.mSet} instead.
|
66170
66325
|
* @arg {} keyValues
|
66171
66326
|
*/
|
66172
66327
|
mset(keyValues: {
|
66173
66328
|
[key: string]: string;
|
66174
66329
|
}): Promise<TxClientLike>;
|
66330
|
+
/**
|
66331
|
+
* Sets the given keys to their respective values.
|
66332
|
+
* https://redis.io/commands/mset/
|
66333
|
+
* @arg {} keyValues
|
66334
|
+
*/
|
66335
|
+
mSet(keyValues: {
|
66336
|
+
[key: string]: string;
|
66337
|
+
}): Promise<TxClientLike>;
|
66175
66338
|
/**
|
66176
66339
|
* Set a timeout on key.
|
66177
66340
|
* https://redis.io/commands/expire/
|
@@ -66283,6 +66446,7 @@ export declare type TxClientLike = {
|
|
66283
66446
|
/**
|
66284
66447
|
* Sets the specified fields to their respective values in the hash stored at key.
|
66285
66448
|
* https://redis.io/commands/hset
|
66449
|
+
* @deprecated Use {@link TxClientLike.hSet} instead.
|
66286
66450
|
* @arg {} key
|
66287
66451
|
* @arg {} fieldValues
|
66288
66452
|
* @returns number of fields that were added
|
@@ -66290,57 +66454,125 @@ export declare type TxClientLike = {
|
|
66290
66454
|
hset(key: string, fieldValues: {
|
66291
66455
|
[field: string]: string;
|
66292
66456
|
}): Promise<TxClientLike>;
|
66457
|
+
/**
|
66458
|
+
* Sets the specified fields to their respective values in the hash stored at key.
|
66459
|
+
* https://redis.io/commands/hset
|
66460
|
+
* @arg {} key
|
66461
|
+
* @arg {} fieldValues
|
66462
|
+
* @returns number of fields that were added
|
66463
|
+
*/
|
66464
|
+
hSet(key: string, fieldValues: {
|
66465
|
+
[field: string]: string;
|
66466
|
+
}): Promise<TxClientLike>;
|
66293
66467
|
/**
|
66294
66468
|
* Returns the value associated with field in the hash stored at key.
|
66295
66469
|
* https://redis.io/commands/hget
|
66470
|
+
* @deprecated Use {@link TxClientLike.hGet} instead.
|
66296
66471
|
* @arg {} key
|
66297
66472
|
* @arg {} field
|
66298
66473
|
* @returns value associated with field
|
66299
66474
|
*/
|
66300
66475
|
hget(key: string, field: string): Promise<TxClientLike>;
|
66476
|
+
/**
|
66477
|
+
* Returns the value associated with field in the hash stored at key.
|
66478
|
+
* https://redis.io/commands/hget
|
66479
|
+
* @arg {} key
|
66480
|
+
* @arg {} field
|
66481
|
+
* @returns value associated with field
|
66482
|
+
*/
|
66483
|
+
hGet(key: string, field: string): Promise<TxClientLike>;
|
66301
66484
|
/**
|
66302
66485
|
* Returns all fields and values of the hash stored at key
|
66303
66486
|
* https://redis.io/commands/hgetall
|
66487
|
+
* @deprecated Use {@link TxClientLike.hGetAll} instead.
|
66304
66488
|
* @arg {} key
|
66305
66489
|
* @returns a map of fields and their values stored in the hash,
|
66306
66490
|
*/
|
66307
66491
|
hgetall(key: string): Promise<TxClientLike>;
|
66492
|
+
/**
|
66493
|
+
* Returns all fields and values of the hash stored at key
|
66494
|
+
* https://redis.io/commands/hgetall
|
66495
|
+
* @arg {} key
|
66496
|
+
* @returns a map of fields and their values stored in the hash,
|
66497
|
+
*/
|
66498
|
+
hGetAll(key: string): Promise<TxClientLike>;
|
66308
66499
|
/**
|
66309
66500
|
* Removes the specified fields from the hash stored at key.
|
66310
66501
|
* https://redis.io/commands/hdel/
|
66502
|
+
* @deprecated Use {@link TxClientLike.hDel} instead.
|
66311
66503
|
* @arg {} key
|
66312
66504
|
* @arg {} fields
|
66313
66505
|
* @returns number of fields that were removed from the hash
|
66314
66506
|
*/
|
66315
66507
|
hdel(key: string, fields: string[]): Promise<TxClientLike>;
|
66508
|
+
/**
|
66509
|
+
* Removes the specified fields from the hash stored at key.
|
66510
|
+
* https://redis.io/commands/hdel/
|
66511
|
+
* @arg {} key
|
66512
|
+
* @arg {} fields
|
66513
|
+
* @returns number of fields that were removed from the hash
|
66514
|
+
*/
|
66515
|
+
hDel(key: string, fields: string[]): Promise<TxClientLike>;
|
66316
66516
|
/**
|
66317
66517
|
* Iterates fields of Hash types and their associated values.
|
66518
|
+
* @deprecated Use {@link TxClientLike.hScan} instead.
|
66318
66519
|
* @arg {} key
|
66319
66520
|
* @arg {} cursor
|
66320
66521
|
* @arg {} pattern
|
66321
66522
|
* @arg {} count
|
66322
66523
|
*/
|
66323
66524
|
hscan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
|
66525
|
+
/**
|
66526
|
+
* Iterates fields of Hash types and their associated values.
|
66527
|
+
* @arg {} key
|
66528
|
+
* @arg {} cursor
|
66529
|
+
* @arg {} pattern
|
66530
|
+
* @arg {} count
|
66531
|
+
*/
|
66532
|
+
hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
|
66324
66533
|
/**
|
66325
66534
|
* Returns all field names in the hash stored at key.
|
66535
|
+
* @deprecated Use {@link TxClientLike.hKeys} instead.
|
66326
66536
|
* @arg {} key
|
66327
66537
|
*/
|
66328
66538
|
hkeys(key: string): Promise<TxClientLike>;
|
66539
|
+
/**
|
66540
|
+
* Returns all field names in the hash stored at key.
|
66541
|
+
* @arg {} key
|
66542
|
+
*/
|
66543
|
+
hKeys(key: string): Promise<TxClientLike>;
|
66329
66544
|
/**
|
66330
66545
|
* Increments the number stored at field in the hash stored at key by increment.
|
66331
66546
|
* https://redis.io/commands/hincrby/
|
66547
|
+
* @deprecated Use {@link TxClientLike.hIncrBy} instead.
|
66332
66548
|
* @arg {} key
|
66333
66549
|
* @arg {} field
|
66334
66550
|
* @arg {} value
|
66335
66551
|
* @returns value of key after the increment
|
66336
66552
|
*/
|
66337
66553
|
hincrby(key: string, field: string, value: number): Promise<TxClientLike>;
|
66554
|
+
/**
|
66555
|
+
* Increments the number stored at field in the hash stored at key by increment.
|
66556
|
+
* https://redis.io/commands/hincrby/
|
66557
|
+
* @arg {} key
|
66558
|
+
* @arg {} field
|
66559
|
+
* @arg {} value
|
66560
|
+
* @returns value of key after the increment
|
66561
|
+
*/
|
66562
|
+
hIncrBy(key: string, field: string, value: number): Promise<TxClientLike>;
|
66338
66563
|
/**
|
66339
66564
|
* Returns the number of fields contained in the hash stored at key.
|
66565
|
+
* @deprecated Use {@link TxClientLike.hLen} instead.
|
66340
66566
|
* @arg {} key
|
66341
66567
|
* @returns the number of fields in the hash, or 0 when the key does not exist.
|
66342
66568
|
*/
|
66343
66569
|
hlen(key: string): Promise<TxClientLike>;
|
66570
|
+
/**
|
66571
|
+
* Returns the number of fields contained in the hash stored at key.
|
66572
|
+
* @arg {} key
|
66573
|
+
* @returns the number of fields in the hash, or 0 when the key does not exist.
|
66574
|
+
*/
|
66575
|
+
hLen(key: string): Promise<TxClientLike>;
|
66344
66576
|
};
|
66345
66577
|
|
66346
66578
|
/**
|
@@ -67230,6 +67462,16 @@ export declare class User {
|
|
67230
67462
|
*/
|
67231
67463
|
getUserFlairBySubreddit(subreddit: string): Promise<UserFlair | undefined>;
|
67232
67464
|
getSnoovatarUrl(): Promise<string | undefined>;
|
67465
|
+
/**
|
67466
|
+
* Gets social links of the user
|
67467
|
+
*
|
67468
|
+
* @returns A Promise that resolves an Array of UserSocialLink objects
|
67469
|
+
* @example
|
67470
|
+
* ```ts
|
67471
|
+
* const socialLinks = await user.getSocialLinks();
|
67472
|
+
* ```
|
67473
|
+
*/
|
67474
|
+
getSocialLinks(): Promise<UserSocialLink[]>;
|
67233
67475
|
}
|
67234
67476
|
|
67235
67477
|
declare interface User_2 {
|
@@ -69364,6 +69606,25 @@ declare const UserSearchResponse_AccountData_Subreddit: {
|
|
69364
69606
|
fromPartial(object: DeepPartial_11<UserSearchResponse_AccountData_Subreddit>): UserSearchResponse_AccountData_Subreddit;
|
69365
69607
|
};
|
69366
69608
|
|
69609
|
+
/**
|
69610
|
+
* @field id: ID of the social link.
|
69611
|
+
*
|
69612
|
+
* @field handle: Display name of social media link.
|
69613
|
+
*
|
69614
|
+
* @field outboundUrl: Outbound url of social media link.
|
69615
|
+
*
|
69616
|
+
* @field type: Type of social media link i.e. Instagram, YouTube.
|
69617
|
+
*
|
69618
|
+
* @field title: Title or name of social media link.
|
69619
|
+
*/
|
69620
|
+
export declare type UserSocialLink = {
|
69621
|
+
id: string;
|
69622
|
+
handle?: string;
|
69623
|
+
outboundUrl: string;
|
69624
|
+
type: SocialLinkType;
|
69625
|
+
title: string;
|
69626
|
+
};
|
69627
|
+
|
69367
69628
|
declare interface UsersSearchRequest {
|
69368
69629
|
/** fullname of a thing */
|
69369
69630
|
after?: string | undefined;
|