@upstash/redis 1.28.2 → 1.28.4-canary

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.
@@ -776,7 +776,7 @@ declare class JsonGetCommand<TData extends (unknown | Record<string, unknown>) |
776
776
  /**
777
777
  * @see https://redis.io/commands/json.mget
778
778
  */
779
- declare class JsonMGetCommand<TData extends (unknown | Record<string, unknown>)[]> extends Command<TData, TData> {
779
+ declare class JsonMGetCommand<TData = unknown[]> extends Command<TData, TData> {
780
780
  constructor(cmd: [keys: string[], path: string], opts?: CommandOptions<TData, TData>);
781
781
  }
782
782
 
@@ -1340,21 +1340,13 @@ type XReadCommandOptions = [
1340
1340
  blockMS?: number;
1341
1341
  }
1342
1342
  ];
1343
- type XReadOptions = XReadCommandOptions extends [infer K, infer I, ...any[]] ? K extends string ? I extends string ? [
1344
- key: string,
1345
- id: string,
1346
- options?: {
1347
- count?: number;
1348
- blockMS?: number;
1349
- }
1350
- ] : never : K extends string[] ? I extends string[] ? [
1351
- key: string[],
1352
- id: string[],
1353
- options?: {
1354
- count?: number;
1355
- blockMS?: number;
1356
- }
1357
- ] : never : never : never;
1343
+ type XReadOptions = XReadCommandOptions extends [infer K, infer I, ...any[]] ? K extends string ? I extends string ? [key: string, id: string, options?: {
1344
+ count?: number;
1345
+ blockMS?: number;
1346
+ }] : never : K extends string[] ? I extends string[] ? [key: string[], id: string[], options?: {
1347
+ count?: number;
1348
+ blockMS?: number;
1349
+ }] : never : never : never;
1358
1350
  /**
1359
1351
  * @see https://redis.io/commands/xread
1360
1352
  */
@@ -1380,19 +1372,7 @@ type XReadGroupOptions = XReadGroupCommandOptions extends [
1380
1372
  infer TKey,
1381
1373
  infer TId,
1382
1374
  ...any[]
1383
- ] ? TKey extends string ? TId extends string ? [
1384
- group: string,
1385
- consumer: string,
1386
- key: string,
1387
- id: string,
1388
- options?: Options
1389
- ] : never : TKey extends string[] ? TId extends string[] ? [
1390
- group: string,
1391
- consumer: string,
1392
- key: string[],
1393
- id: string[],
1394
- options?: Options
1395
- ] : never : never : never;
1375
+ ] ? 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;
1396
1376
  /**
1397
1377
  * @see https://redis.io/commands/xreadgroup
1398
1378
  */
@@ -1669,10 +1649,7 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
1669
1649
  */
1670
1650
  bitop: {
1671
1651
  (op: "and" | "or" | "xor", destinationKey: string, sourceKey: string, ...sourceKeys: string[]): Pipeline<[...TCommands, BitOpCommand]>;
1672
- (op: "not", destinationKey: string, sourceKey: string): Pipeline<[
1673
- ...TCommands,
1674
- BitOpCommand
1675
- ]>;
1652
+ (op: "not", destinationKey: string, sourceKey: string): Pipeline<[...TCommands, BitOpCommand]>;
1676
1653
  };
1677
1654
  /**
1678
1655
  * @see https://redis.io/commands/bitpos
@@ -1738,6 +1715,96 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
1738
1715
  flushdb: (opts?: {
1739
1716
  async?: boolean | undefined;
1740
1717
  } | undefined) => Pipeline<[...TCommands, Command<any, "OK">]>;
1718
+ /**
1719
+ * @see https://redis.io/commands/geoadd
1720
+ */
1721
+ geoadd: (args_0: string, args_1: GeoAddCommandOptions | GeoMember<unknown>, ...args_2: GeoMember<unknown>[]) => Pipeline<[...TCommands, Command<any, number | null>]>;
1722
+ /**
1723
+ * @see https://redis.io/commands/geodist
1724
+ */
1725
+ geodist: (key: string, member1: unknown, member2: unknown, unit?: "M" | "KM" | "FT" | "MI" | undefined) => Pipeline<[...TCommands, Command<any, number | null>]>;
1726
+ /**
1727
+ * @see https://redis.io/commands/geopos
1728
+ */
1729
+ geopos: (args_0: string, ...args_1: unknown[]) => Pipeline<[...TCommands, Command<any, {
1730
+ lng: number;
1731
+ lat: number;
1732
+ }[]>]>;
1733
+ /**
1734
+ * @see https://redis.io/commands/geohash
1735
+ */
1736
+ geohash: (args_0: string, ...args_1: unknown[]) => Pipeline<[...TCommands, Command<any, (string | null)[]>]>;
1737
+ /**
1738
+ * @see https://redis.io/commands/geosearch
1739
+ */
1740
+ geosearch: (key: string, centerPoint: {
1741
+ type: "FROMLONLAT" | "fromlonlat";
1742
+ coordinate: {
1743
+ lon: number;
1744
+ lat: number;
1745
+ };
1746
+ } | {
1747
+ type: "FROMMEMBER" | "frommember";
1748
+ member: unknown;
1749
+ }, shape: {
1750
+ type: "BYRADIUS" | "byradius";
1751
+ radius: number;
1752
+ radiusType: "M" | "KM" | "FT" | "MI";
1753
+ } | {
1754
+ type: "BYBOX" | "bybox";
1755
+ rect: {
1756
+ width: number;
1757
+ height: number;
1758
+ };
1759
+ rectType: "M" | "KM" | "FT" | "MI";
1760
+ }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
1761
+ count?: {
1762
+ limit: number;
1763
+ any?: boolean | undefined;
1764
+ } | undefined;
1765
+ withCoord?: boolean | undefined;
1766
+ withDist?: boolean | undefined;
1767
+ withHash?: boolean | undefined;
1768
+ } | undefined) => Pipeline<[...TCommands, Command<any, ({
1769
+ member: unknown;
1770
+ } & {
1771
+ coord?: {
1772
+ long: number;
1773
+ lat: number;
1774
+ } | undefined;
1775
+ dist?: number | undefined;
1776
+ hash?: string | undefined;
1777
+ })[]>]>;
1778
+ /**
1779
+ * @see https://redis.io/commands/geosearchstore
1780
+ */
1781
+ geosearchstore: (destination: string, key: string, centerPoint: {
1782
+ type: "FROMLONLAT" | "fromlonlat";
1783
+ coordinate: {
1784
+ lon: number;
1785
+ lat: number;
1786
+ };
1787
+ } | {
1788
+ type: "FROMMEMBER" | "frommember";
1789
+ member: unknown;
1790
+ }, shape: {
1791
+ type: "BYRADIUS" | "byradius";
1792
+ radius: number;
1793
+ radiusType: "M" | "KM" | "FT" | "MI";
1794
+ } | {
1795
+ type: "BYBOX" | "bybox";
1796
+ rect: {
1797
+ width: number;
1798
+ height: number;
1799
+ };
1800
+ rectType: "M" | "KM" | "FT" | "MI";
1801
+ }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
1802
+ count?: {
1803
+ limit: number;
1804
+ any?: boolean | undefined;
1805
+ } | undefined;
1806
+ storeDist?: boolean | undefined;
1807
+ } | undefined) => Pipeline<[...TCommands, Command<any, number>]>;
1741
1808
  /**
1742
1809
  * @see https://redis.io/commands/get
1743
1810
  */
@@ -2351,96 +2418,6 @@ declare class Pipeline<TCommands extends Command<any, any>[] = []> {
2351
2418
  * @see https://redis.io/commands/json.forget
2352
2419
  */
2353
2420
  forget: (key: string, path?: string | undefined) => Pipeline<[...TCommands, Command<any, number>]>;
2354
- /**
2355
- * @see https://redis.io/commands/geoadd
2356
- */
2357
- geoadd: (args_0: string, args_1: GeoAddCommandOptions | GeoMember<unknown>, ...args_2: GeoMember<unknown>[]) => Pipeline<[...TCommands, Command<any, number | null>]>;
2358
- /**
2359
- * @see https://redis.io/commands/geodist
2360
- */
2361
- geodist: (key: string, member1: unknown, member2: unknown, unit?: "M" | "KM" | "FT" | "MI" | undefined) => Pipeline<[...TCommands, Command<any, number | null>]>;
2362
- /**
2363
- * @see https://redis.io/commands/geopos
2364
- */
2365
- geopos: (args_0: string, ...args_1: unknown[]) => Pipeline<[...TCommands, Command<any, {
2366
- lng: number;
2367
- lat: number;
2368
- }[]>]>;
2369
- /**
2370
- * @see https://redis.io/commands/geohash
2371
- */
2372
- geohash: (args_0: string, ...args_1: unknown[]) => Pipeline<[...TCommands, Command<any, (string | null)[]>]>;
2373
- /**
2374
- * @see https://redis.io/commands/geosearch
2375
- */
2376
- geosearch: (key: string, centerPoint: {
2377
- type: "FROMLONLAT" | "fromlonlat";
2378
- coordinate: {
2379
- lon: number;
2380
- lat: number;
2381
- };
2382
- } | {
2383
- type: "FROMMEMBER" | "frommember";
2384
- member: unknown;
2385
- }, shape: {
2386
- type: "BYRADIUS" | "byradius";
2387
- radius: number;
2388
- radiusType: "M" | "KM" | "FT" | "MI";
2389
- } | {
2390
- type: "BYBOX" | "bybox";
2391
- rect: {
2392
- width: number;
2393
- height: number;
2394
- };
2395
- rectType: "M" | "KM" | "FT" | "MI";
2396
- }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
2397
- count?: {
2398
- limit: number;
2399
- any?: boolean | undefined;
2400
- } | undefined;
2401
- withCoord?: boolean | undefined;
2402
- withDist?: boolean | undefined;
2403
- withHash?: boolean | undefined;
2404
- } | undefined) => Pipeline<[...TCommands, Command<any, ({
2405
- member: unknown;
2406
- } & {
2407
- coord?: {
2408
- long: number;
2409
- lat: number;
2410
- } | undefined;
2411
- dist?: number | undefined;
2412
- hash?: string | undefined;
2413
- })[]>]>;
2414
- /**
2415
- * @see https://redis.io/commands/geosearchstore
2416
- */
2417
- geosearchstore: (destination: string, key: string, centerPoint: {
2418
- type: "FROMLONLAT" | "fromlonlat";
2419
- coordinate: {
2420
- lon: number;
2421
- lat: number;
2422
- };
2423
- } | {
2424
- type: "FROMMEMBER" | "frommember";
2425
- member: unknown;
2426
- }, shape: {
2427
- type: "BYRADIUS" | "byradius";
2428
- radius: number;
2429
- radiusType: "M" | "KM" | "FT" | "MI";
2430
- } | {
2431
- type: "BYBOX" | "bybox";
2432
- rect: {
2433
- width: number;
2434
- height: number;
2435
- };
2436
- rectType: "M" | "KM" | "FT" | "MI";
2437
- }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
2438
- count?: {
2439
- limit: number;
2440
- any?: boolean | undefined;
2441
- } | undefined;
2442
- storeDist?: boolean | undefined;
2443
- } | undefined) => Pipeline<[...TCommands, Command<any, number>]>;
2444
2421
  /**
2445
2422
  * @see https://redis.io/commands/json.get
2446
2423
  */
@@ -2596,104 +2573,14 @@ declare class Redis {
2596
2573
  * @see https://redis.io/commands/json.forget
2597
2574
  */
2598
2575
  forget: (key: string, path?: string | undefined) => Promise<number>;
2599
- /**
2600
- * @see https://redis.io/commands/geoadd
2601
- */
2602
- geoadd: (args_0: string, args_1: GeoAddCommandOptions | GeoMember<unknown>, ...args_2: GeoMember<unknown>[]) => Promise<number | null>;
2603
- /**
2604
- * @see https://redis.io/commands/geopos
2605
- */
2606
- geopos: (args_0: string, ...args_1: unknown[]) => Promise<{
2607
- lng: number;
2608
- lat: number;
2609
- }[]>;
2610
- /**
2611
- * @see https://redis.io/commands/geodist
2612
- */
2613
- geodist: (key: string, member1: unknown, member2: unknown, unit?: "M" | "KM" | "FT" | "MI" | undefined) => Promise<number | null>;
2614
- /**
2615
- * @see https://redis.io/commands/geohash
2616
- */
2617
- geohash: (args_0: string, ...args_1: unknown[]) => Promise<(string | null)[]>;
2618
- /**
2619
- * @see https://redis.io/commands/geosearch
2620
- */
2621
- geosearch: (key: string, centerPoint: {
2622
- type: "FROMLONLAT" | "fromlonlat";
2623
- coordinate: {
2624
- lon: number;
2625
- lat: number;
2626
- };
2627
- } | {
2628
- type: "FROMMEMBER" | "frommember";
2629
- member: unknown;
2630
- }, shape: {
2631
- type: "BYRADIUS" | "byradius";
2632
- radius: number;
2633
- radiusType: "M" | "KM" | "FT" | "MI";
2634
- } | {
2635
- type: "BYBOX" | "bybox";
2636
- rect: {
2637
- width: number;
2638
- height: number;
2639
- };
2640
- rectType: "M" | "KM" | "FT" | "MI";
2641
- }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
2642
- count?: {
2643
- limit: number;
2644
- any?: boolean | undefined;
2645
- } | undefined;
2646
- withCoord?: boolean | undefined;
2647
- withDist?: boolean | undefined;
2648
- withHash?: boolean | undefined;
2649
- } | undefined) => Promise<({
2650
- member: unknown;
2651
- } & {
2652
- coord?: {
2653
- long: number;
2654
- lat: number;
2655
- } | undefined;
2656
- dist?: number | undefined;
2657
- hash?: string | undefined;
2658
- })[]>;
2659
- /**
2660
- * @see https://redis.io/commands/geosearchstore
2661
- */
2662
- geosearchstore: (destination: string, key: string, centerPoint: {
2663
- type: "FROMLONLAT" | "fromlonlat";
2664
- coordinate: {
2665
- lon: number;
2666
- lat: number;
2667
- };
2668
- } | {
2669
- type: "FROMMEMBER" | "frommember";
2670
- member: unknown;
2671
- }, shape: {
2672
- type: "BYRADIUS" | "byradius";
2673
- radius: number;
2674
- radiusType: "M" | "KM" | "FT" | "MI";
2675
- } | {
2676
- type: "BYBOX" | "bybox";
2677
- rect: {
2678
- width: number;
2679
- height: number;
2680
- };
2681
- rectType: "M" | "KM" | "FT" | "MI";
2682
- }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
2683
- count?: {
2684
- limit: number;
2685
- any?: boolean | undefined;
2686
- } | undefined;
2687
- storeDist?: boolean | undefined;
2688
- } | undefined) => Promise<number>;
2689
2576
  /**
2690
2577
  * @see https://redis.io/commands/json.get
2691
2578
  */
2692
- get: (...args: CommandArgs<typeof JsonGetCommand>) => Promise<any>;
2579
+ get: <TData>(...args: CommandArgs<typeof JsonGetCommand>) => Promise<TData | null>;
2693
2580
  /**
2694
2581
  * @see https://redis.io/commands/json.mget
2695
2582
  */
2696
- mget: (keys: string[], path: string) => Promise<any>;
2583
+ mget: <TData_1>(keys: string[], path: string) => Promise<TData_1>;
2697
2584
  /**
2698
2585
  * @see https://redis.io/commands/json.numincrby
2699
2586
  */
@@ -2841,6 +2728,96 @@ declare class Redis {
2841
2728
  flushdb: (opts?: {
2842
2729
  async?: boolean | undefined;
2843
2730
  } | undefined) => Promise<"OK">;
2731
+ /**
2732
+ * @see https://redis.io/commands/geoadd
2733
+ */
2734
+ geoadd: (args_0: string, args_1: GeoAddCommandOptions | GeoMember<unknown>, ...args_2: GeoMember<unknown>[]) => Promise<number | null>;
2735
+ /**
2736
+ * @see https://redis.io/commands/geopos
2737
+ */
2738
+ geopos: (args_0: string, ...args_1: unknown[]) => Promise<{
2739
+ lng: number;
2740
+ lat: number;
2741
+ }[]>;
2742
+ /**
2743
+ * @see https://redis.io/commands/geodist
2744
+ */
2745
+ geodist: (key: string, member1: unknown, member2: unknown, unit?: "M" | "KM" | "FT" | "MI" | undefined) => Promise<number | null>;
2746
+ /**
2747
+ * @see https://redis.io/commands/geohash
2748
+ */
2749
+ geohash: (args_0: string, ...args_1: unknown[]) => Promise<(string | null)[]>;
2750
+ /**
2751
+ * @see https://redis.io/commands/geosearch
2752
+ */
2753
+ geosearch: (key: string, centerPoint: {
2754
+ type: "FROMLONLAT" | "fromlonlat";
2755
+ coordinate: {
2756
+ lon: number;
2757
+ lat: number;
2758
+ };
2759
+ } | {
2760
+ type: "FROMMEMBER" | "frommember";
2761
+ member: unknown;
2762
+ }, shape: {
2763
+ type: "BYRADIUS" | "byradius";
2764
+ radius: number;
2765
+ radiusType: "M" | "KM" | "FT" | "MI";
2766
+ } | {
2767
+ type: "BYBOX" | "bybox";
2768
+ rect: {
2769
+ width: number;
2770
+ height: number;
2771
+ };
2772
+ rectType: "M" | "KM" | "FT" | "MI";
2773
+ }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
2774
+ count?: {
2775
+ limit: number;
2776
+ any?: boolean | undefined;
2777
+ } | undefined;
2778
+ withCoord?: boolean | undefined;
2779
+ withDist?: boolean | undefined;
2780
+ withHash?: boolean | undefined;
2781
+ } | undefined) => Promise<({
2782
+ member: unknown;
2783
+ } & {
2784
+ coord?: {
2785
+ long: number;
2786
+ lat: number;
2787
+ } | undefined;
2788
+ dist?: number | undefined;
2789
+ hash?: string | undefined;
2790
+ })[]>;
2791
+ /**
2792
+ * @see https://redis.io/commands/geosearchstore
2793
+ */
2794
+ geosearchstore: (destination: string, key: string, centerPoint: {
2795
+ type: "FROMLONLAT" | "fromlonlat";
2796
+ coordinate: {
2797
+ lon: number;
2798
+ lat: number;
2799
+ };
2800
+ } | {
2801
+ type: "FROMMEMBER" | "frommember";
2802
+ member: unknown;
2803
+ }, shape: {
2804
+ type: "BYRADIUS" | "byradius";
2805
+ radius: number;
2806
+ radiusType: "M" | "KM" | "FT" | "MI";
2807
+ } | {
2808
+ type: "BYBOX" | "bybox";
2809
+ rect: {
2810
+ width: number;
2811
+ height: number;
2812
+ };
2813
+ rectType: "M" | "KM" | "FT" | "MI";
2814
+ }, order: "ASC" | "DESC" | "asc" | "desc", opts?: {
2815
+ count?: {
2816
+ limit: number;
2817
+ any?: boolean | undefined;
2818
+ } | undefined;
2819
+ storeDist?: boolean | undefined;
2820
+ } | undefined) => Promise<number>;
2844
2821
  /**
2845
2822
  * @see https://redis.io/commands/get
2846
2823
  */