@upstash/redis 0.1.2 → 0.1.6

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,70 @@ 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().
+
+### Edge Support
+
+Once you set `edgeUrl`, all read commands are fetched using edge url. The REST URL is used for write/update commands.
 
 ```typescript
-import { get } from '@upstash/redis';
+import { auth, get } from '@upstash/redis';
+
+auth({
+  url: 'UPSTASH_REDIS_REST_URL',
+  token: 'UPSTASH_REDIS_REST_TOKEN',
+  edgeUrl: 'UPSTASH_REDIS_EDGE_URL',
+});
 
 (async () => {
   try {
-    const { data, error } = await get('key');
+    // the below reads using edge url
+    const { data, error, metadata } = await get('key');
     if (error) throw error;
     console.log(data);
+    // -> null | string
+    console.log(metadata);
+    // -> { edge: boolean, cache: null | 'miss' | 'hit' }
+
+    // the below reads using REST url (non-edge)
+    const get1 = await get('key', { edge: false });
+    if (get1.error) throw get1.error;
   } catch (error) {
     console.error(error);
   }
 })();
 ```
+
+## Docs
+
+See [the documentation](https://docs.upstash.com/features/javascriptsdk) for details.

package/dist/main/{src/client.d.ts → client.d.ts}

@@ -1,4 +1,4 @@
-import { ClientObjectProps, Upstash } from './type';
+import { ClientObjectProps, Upstash } from './types';
 /**
  * Creates a Upstash Redis instance
  *
@@ -13,13 +13,12 @@ import { ClientObjectProps, Upstash } from './type';
  *
  * @example
  * ```js
- * import Upstash from '@upstash/redis'
+ * import upstash from '@upstash/redis'
  *
- * const redis1 = new Upstash('url', token);
- * const redis2 = new Upstash({ url: '', token: '', edgeUrl: '', readFromEdge: false });
+ * const redis1 = upstash('url', token);
+ * const redis2 = upstash({ url: '', token: '', edgeUrl: '', readFromEdge: false });
  * ```
  */
-export default Upstash;
-declare function Upstash(url?: string, token?: string): Upstash;
-declare function Upstash(options?: ClientObjectProps): Upstash;
-//# sourceMappingURL=client.d.ts.map
+declare function upstash(options?: ClientObjectProps): Upstash;
+declare function upstash(url?: string, token?: string): Upstash;
+export default upstash;