@upstash/redis 0.1.11 → 0.2.1

package/README.md

@@ -9,7 +9,7 @@ An HTTP/REST based Redis client built on top of [Upstash REST API](https://docs.
 It is the only connectionless (HTTP based) Redis client and designed for:
 
 - Serverless functions (AWS Lambda ...)
-- Cloudflare Workers (see [the example](https://github.com/upstash/upstash-redis/tree/master/examples/workers-with-upstash))
+- Cloudflare Workers (see [the example](https://github.com/upstash/upstash-redis/tree/master/examples/cloudflare-workers))
 - Fastly Compute@Edge
 - Next.js, Jamstack ...
 - Client side web/mobile applications
@@ -26,51 +26,38 @@ See [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-ap
 npm install @upstash/redis
 ```
 
-### Usage with Callback Style
+### Usage with Promise
 
 ```typescript
-import upstash from '@upstash/redis';
+import { auth, set } from '@upstash/redis';
 
-const redis = upstash('UPSTASH_REDIS_REST_URL', 'UPSTASH_REDIS_REST_TOKEN');
+auth('UPSTASH_REDIS_REST_URL', 'UPSTASH_REDIS_REST_TOKEN');
 
-redis.get('key', function ({ data, error }) {
-  if (error) {
-    return console.error(error);
-  }
+set('key', 'value').then(({ data }) => {
   console.log(data);
+  // -> "OK"
 });
 ```
 
-### Usage with async/await (Promise)
+### Usage with async/await
 
 ```typescript
-import upstash from '@upstash/redis';
-
-const redis = upstash('UPSTASH_REDIS_REST_URL', 'UPSTASH_REDIS_REST_TOKEN');
+import { set } from '@upstash/redis';
 
 (async () => {
   try {
-    const { data, error } = await redis.get('key');
+    const { data, error } = await set('key', 'value');
     if (error) throw error;
     console.log(data);
+    // -> "OK"
   } catch (error) {
     console.error(error);
   }
 })();
 ```
 
-If you define `UPSTASH_REDIS_REST_URL` and` UPSTASH_REDIS_REST_TOKEN` environment variables, you can run the Redis commands directly.
+> If you define `UPSTASH_REDIS_REST_URL` and` UPSTASH_REDIS_REST_TOKEN` environment variables, you can skip the auth().
 
-```typescript
-import { get } from '@upstash/redis';
+## Docs
 
-(async () => {
-  try {
-    const { data, error } = await get('key');
-    if (error) throw error;
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-})();
-```
+See [the documentation](https://docs.upstash.com/features/javascriptsdk) for details.

package/dist/main/client.d.ts

@@ -1,158 +1,21 @@
-export declare type ReturnType = {
-    data: string | number | [] | any;
-    error: string | null;
-};
-declare type MethodReturn = Promise<ReturnType>;
-declare type Callback = (res: ReturnType) => any;
-declare type Bit = 0 | 1;
-declare type Infinities = '+inf' | '-inf';
-declare type ZSetNumber = number | Infinities | string;
+import { ClientObjectProps, Upstash } from './types';
 /**
- * Upstash client
- * @param {string} url - database rest url
- * @param {string} token - database rest token
+ * Creates a Upstash Redis instance
+ *
+ * @constructor
+ * @param {Object} options
+ * @param {string} [options.url]
+ * @param {string} [options.token]
+ * @param {Object} [options.requestOptions]
+ *
+ * @example
+ * ```js
+ * import upstash from '@upstash/redis'
+ *
+ * const redis1 = upstash('url', token);
+ * const redis2 = upstash({ url: '', token: '', requestOptions: {} });
+ * ```
  */
-export default function client(url?: string, token?: string): {
-    auth: (url: string, token: string) => void;
-    append: (key: string, value: string, callback?: Callback | undefined) => MethodReturn;
-    decr: (key: string, callback?: Callback | undefined) => MethodReturn;
-    decrby: (key: string, decrement: number, callback?: Callback | undefined) => MethodReturn;
-    get: (key: string, callback?: Callback | undefined) => MethodReturn;
-    getrange: (key: string, start: number, end: number, callback?: Callback | undefined) => MethodReturn;
-    getset: (key: string, value: string, callback?: Callback | undefined) => MethodReturn;
-    incr: (key: string, callback?: Callback | undefined) => MethodReturn;
-    incrby: (key: string, value: number | string, callback?: Callback | undefined) => MethodReturn;
-    incrbyfloat: (key: string, value: number | string, callback?: Callback | undefined) => MethodReturn;
-    mget: (values: string[], callback?: Callback | undefined) => MethodReturn;
-    mset: (values: string[], callback?: Callback | undefined) => MethodReturn;
-    msetnx: (values: string[], callback?: Callback | undefined) => MethodReturn;
-    psetex: (key: string, miliseconds: number, value: string | number, callback?: Callback | undefined) => MethodReturn;
-    set: (key: string, value: string | number, callback?: Callback | undefined) => MethodReturn;
-    setex: (key: string, seconds: number, value: string | number, callback?: Callback | undefined) => MethodReturn;
-    setnx: (key: string, value: string, callback?: Callback | undefined) => MethodReturn;
-    setrange: (key: string, offset: number | string, value: string, callback?: Callback | undefined) => MethodReturn;
-    strlen: (key: string, callback?: Callback | undefined) => MethodReturn;
-    bitcount: (key: string, start?: number | undefined, end?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    bitop: (operation: 'AND' | 'OR' | 'XOR' | 'NOT', destinationKey: string, sourceKeys: string[], callback?: Callback | undefined) => MethodReturn;
-    bitpos: (key: string, bit: Bit, start?: number | undefined, end?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    getbit: (key: string, offset: number, callback?: Callback | undefined) => MethodReturn;
-    setbit: (key: string, offset: number, value: Bit, callback?: Callback | undefined) => MethodReturn;
-    echo: (value: string, callback?: Callback | undefined) => MethodReturn;
-    ping: (value?: string | undefined, callback?: Callback | undefined) => MethodReturn;
-    hdel: (key: string, fields: string[], callback?: Callback | undefined) => MethodReturn;
-    hexists: (key: string, field: string, callback?: Callback | undefined) => MethodReturn;
-    hget: (key: string, field: string, callback?: Callback | undefined) => MethodReturn;
-    hgetall: (key: string, callback?: Callback | undefined) => MethodReturn;
-    hincrby: (key: string, field: string, increment: number | string, callback?: Callback | undefined) => MethodReturn;
-    hincrbyfloat: (key: string, field: string, increment: number | string, callback?: Callback | undefined) => MethodReturn;
-    hkeys: (key: string, callback?: Callback | undefined) => MethodReturn;
-    hlen: (key: string, callback?: Callback | undefined) => MethodReturn;
-    hmget: (key: string, fields: string[], callback?: Callback | undefined) => MethodReturn;
-    hmset: (key: string, values: string[], callback?: Callback | undefined) => MethodReturn;
-    hset: (key: string, values: string[], callback?: Callback | undefined) => MethodReturn;
-    hsetnx: (key: string, field: string, value: string, callback?: Callback | undefined) => MethodReturn;
-    hvals: (key: string, callback?: Callback | undefined) => MethodReturn;
-    hscan: (key: string, cursor: number, options?: {
-        match?: string | number | undefined;
-        count?: string | number | undefined;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-    del: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    exists: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    expire: (key: string, seconds: number, callback?: Callback | undefined) => MethodReturn;
-    expireat: (key: string, timestamp: number | string, callback?: Callback | undefined) => MethodReturn;
-    keys: (pattern: string, callback?: Callback | undefined) => MethodReturn;
-    persist: (key: string, callback?: Callback | undefined) => MethodReturn;
-    pexpire: (key: string, miliseconds: number, callback?: Callback | undefined) => MethodReturn;
-    pexpireat: (key: string, miliseconds: number, callback?: Callback | undefined) => MethodReturn;
-    pttl: (key: string, callback?: Callback | undefined) => MethodReturn;
-    randomkey: (callback?: Callback | undefined) => MethodReturn;
-    rename: (key: string, newkey: string, callback?: Callback | undefined) => MethodReturn;
-    renamenx: (key: string, newkey: string, callback?: Callback | undefined) => MethodReturn;
-    scan: (cursor: number, opitons?: {
-        match?: string | number | undefined;
-        count?: string | number | undefined;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-    touch: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    ttl: (key: string, callback?: Callback | undefined) => MethodReturn;
-    type: (key: string, callback?: Callback | undefined) => MethodReturn;
-    unlink: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    lindex: (key: string, index: number, callback?: Callback | undefined) => MethodReturn;
-    linsert: (key: string, option: 'BEFORE' | 'AFTER', pivot: string, element: string, callback?: Callback | undefined) => MethodReturn;
-    llen: (key: string, callback?: Callback | undefined) => MethodReturn;
-    lpop: (key: string, callback?: Callback | undefined) => MethodReturn;
-    lpush: (key: string, elements: string[], callback?: Callback | undefined) => MethodReturn;
-    lpushx: (key: string, elements: string[], callback?: Callback | undefined) => MethodReturn;
-    lrange: (key: string, start: number, stop: number, callback?: Callback | undefined) => MethodReturn;
-    lrem: (key: string, count: number, element: string, callback?: Callback | undefined) => MethodReturn;
-    lset: (key: string, index: number, element: string, callback?: Callback | undefined) => MethodReturn;
-    ltrim: (key: string, start: number, stop: number, callback?: Callback | undefined) => MethodReturn;
-    rpop: (key: string, callback?: Callback | undefined) => MethodReturn;
-    rpoplpush: (source: string, destination: string, callback?: Callback | undefined) => MethodReturn;
-    rpush: (key: string, elements: string[], callback?: Callback | undefined) => MethodReturn;
-    rpushx: (key: string, elements: string[], callback?: Callback | undefined) => MethodReturn;
-    dbsize: (callback?: Callback | undefined) => MethodReturn;
-    flushall: (mode?: "ASYNC" | undefined, callback?: Callback | undefined) => MethodReturn;
-    flushdb: (mode?: "ASYNC" | undefined, callback?: Callback | undefined) => MethodReturn;
-    info: (callback?: Callback | undefined) => MethodReturn;
-    time: (callback?: Callback | undefined) => MethodReturn;
-    sadd: (key: string, members: string[], callback?: Callback | undefined) => MethodReturn;
-    scard: (key: string, callback?: Callback | undefined) => MethodReturn;
-    sdiff: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    sdiffstore: (destination: string, keys: string[], callback?: Callback | undefined) => MethodReturn;
-    sinter: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    sinterstore: (destination: string, keys: string[], callback?: Callback | undefined) => MethodReturn;
-    sismember: (key: string, member: string, callback?: Callback | undefined) => MethodReturn;
-    smembers: (key: string, callback?: Callback | undefined) => MethodReturn;
-    smove: (source: string, destination: string, member: string, callback?: Callback | undefined) => MethodReturn;
-    spop: (key: string, count?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    srandmember: (key: string, count?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    srem: (key: string, members: string[], callback?: Callback | undefined) => MethodReturn;
-    sunion: (keys: string[], callback?: Callback | undefined) => MethodReturn;
-    sunionstore: (destination: string, keys: string[], callback?: Callback | undefined) => MethodReturn;
-    zadd: (key: string, values: ZSetNumber[], options?: (({
-        xx?: boolean | undefined;
-    } | {
-        nx?: boolean | undefined;
-    }) & {
-        ch?: boolean | undefined;
-        incr: boolean;
-    }) | undefined, callback?: Callback | undefined) => MethodReturn;
-    zcard: (key: string, callback?: Callback | undefined) => MethodReturn;
-    zcount: (key: string, min: ZSetNumber, max: ZSetNumber, callback?: Callback | undefined) => MethodReturn;
-    zincrby: (key: string, increment: number | string, member: string, callback?: Callback | undefined) => MethodReturn;
-    zinterstore: (destination: string, keys: string[], options?: {
-        weights?: number[] | undefined;
-        aggregate?: "MIN" | "MAX" | "SUM" | undefined;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-    zlexcount: (key: string, min: ZSetNumber, max: ZSetNumber, callback?: Callback | undefined) => MethodReturn;
-    zpopmax: (key: string, count?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    zpopmin: (key: string, count?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    zrange: (key: string, min: ZSetNumber, max: ZSetNumber, options?: {
-        withScores: boolean;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-    zrangebylex: (key: string, min: ZSetNumber, max: ZSetNumber, offset?: number | undefined, count?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    zrangebyscore: (key: string, min: ZSetNumber, max: ZSetNumber, options?: {
-        withScores?: boolean | undefined;
-        limit?: {
-            offset: number;
-            count: number;
-        } | undefined;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-    zrank: (key: string, member: string, callback?: Callback | undefined) => MethodReturn;
-    zrem: (key: string, members: string[], callback?: Callback | undefined) => MethodReturn;
-    zremrangebylex: (key: string, min: ZSetNumber, max: ZSetNumber, callback?: Callback | undefined) => MethodReturn;
-    zremrangebyrank: (key: string, start: number, stop: number, callback?: Callback | undefined) => MethodReturn;
-    zremrangebyscore: (key: string, min: ZSetNumber, max: ZSetNumber, callback?: Callback | undefined) => MethodReturn;
-    zrevrange: (key: string, start: number, stop: number, options?: {
-        withScores: boolean;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-    zrevrangebylex: (key: string, max: ZSetNumber, min: ZSetNumber, offset?: number | undefined, count?: number | undefined, callback?: Callback | undefined) => MethodReturn;
-    zrevrangebyscore: (key: string, min: ZSetNumber, max: ZSetNumber, callback?: Callback | undefined) => MethodReturn;
-    zscore: (key: string, member: string, callback?: Callback | undefined) => MethodReturn;
-    zunionstore: (destination: string, keys: string[], options?: {
-        weights?: number[] | undefined;
-        aggregate?: "MIN" | "MAX" | "SUM" | undefined;
-    } | undefined, callback?: Callback | undefined) => MethodReturn;
-};
-export {};
-//# sourceMappingURL=client.d.ts.map
+declare function upstash(options?: ClientObjectProps): Upstash;
+declare function upstash(url?: string, token?: string): Upstash;
+export default upstash;