@upstash/redis 0.1.3 → 0.1.7

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

package/dist/main/client.d.ts

@@ -1,25 +1,21 @@
-import { ClientObjectProps, Upstash } from './type';
+import { ClientObjectProps, Upstash } from './types';
 /**
  * Creates a Upstash Redis instance
  *
  * @constructor
- * @param {string} url - database rest url
- * @param {string} token - database rest token
- * @param {Object} options - database config
- * @param {string} [options.url] - database rest url
- * @param {string} [options.token] - database rest token
- * @param {string} [options.edgeUrl] - database rest edge url
- * @param {string} [options.readFromEdge] - database rest read from edge
+ * @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: '', edgeUrl: '', readFromEdge: false });
+ * const redis2 = upstash({ url: '', token: '', requestOptions: {} });
  * ```
  */
 declare function upstash(options?: ClientObjectProps): Upstash;
 declare function upstash(url?: string, token?: string): Upstash;
 export default upstash;
-//# sourceMappingURL=client.d.ts.map