@upstash/redis 0.2.0 → 1.0.0-alpha.1

package/package.json

@@ -1,75 +1 @@
-{
-  "name": "@upstash/redis",
-  "version": "0.2.0",
-  "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
-  "author": "Adem ilter <adem@upstash.com>",
-  "license": "MIT",
-  "main": "dist/main/index-cjs.js",
-  "module": "dist/module/index.js",
-  "types": "dist/module/index.d.ts",
-  "scripts": {
-    "clean": "rimraf dist",
-    "format": "prettier --write \"{src,test}/**/*.ts\"",
-    "build": "run-s clean format build:*",
-    "build:main": "tsc -p tsconfig.json",
-    "build:module": "tsc -p tsconfig.module.json",
-    "test": "jest --runInBand && npm run size",
-    "size": "size-limit"
-  },
-  "dependencies": {
-    "isomorphic-unfetch": "^3.1.0"
-  },
-  "devDependencies": {
-    "@size-limit/preset-small-lib": "^6.0.4",
-    "@types/jest": "^27.0.2",
-    "@types/node-fetch": "^2.5.12",
-    "dotenv": "^10.0.0",
-    "jest": "^27.3.1",
-    "nanoid": "^3.1.30",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
-    "size-limit": "^6.0.4",
-    "ts-jest": "^27.0.7",
-    "ts-loader": "^9.2.6",
-    "typescript": "^4.5.2"
-  },
-  "size-limit": [
-    {
-      "path": "dist/main/index-cjs.js",
-      "limit": "3 KB"
-    },
-    {
-      "path": "dist/module/index.js",
-      "limit": "3 KB"
-    }
-  ],
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "es5"
-  },
-  "engines": {
-    "node": ">=10"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/upstash/upstash-redis.git"
-  },
-  "bugs": {
-    "url": "https://github.com/upstash/upstash-redis/issues"
-  },
-  "homepage": "https://github.com/upstash/upstash-redis#readme",
-  "directories": {
-    "example": "examples",
-    "test": "test"
-  },
-  "keywords": [
-    "redis",
-    "database",
-    "serverless",
-    "edge",
-    "upstash"
-  ]
-}
+{ "name": "@upstash/redis", "version": "v1.0.0-alpha.1", "engines": { "node": ">=10" }, "description": "An HTTP/REST based Redis client built on top of Upstash REST API.", "main": "./dist/index.js", "module": "./dist/index.mjs", "types": "./dist/index.d.ts", "exports": { ".": { "require": "./dist/index.js", "import": "./dist/index.mjs", "types": "./dist/index.d.ts" } }, "files": [ "package.json", "dist" ], "scripts": { "test": "jest -i", "fmt": "pnpm lint && pnpm prettier --write .", "lint": "eslint --ext .ts --fix --ignore-path .gitignore .", "build": "tsup && pnpm size-limit" }, "repository": { "type": "git", "url": "git+https://github.com/upstash/upstash-redis.git" }, "keywords": [ "redis", "database", "serverless", "edge", "upstash" ], "author": "Andreas Thomas <andreas.thomas@chronark.com>", "license": "MIT", "bugs": { "url": "https://github.com/upstash/upstash-redis/issues" }, "homepage": "https://github.com/upstash/upstash-redis#readme", "directories": { "examples": "examples" }, "devDependencies": { "@jest/globals": "^27.4.6", "@size-limit/preset-small-lib": "^7.0.8", "@trivago/prettier-plugin-sort-imports": "^3.2.0", "@types/jest": "^27.4.0", "@types/node": "^17.0.8", "@typescript-eslint/eslint-plugin": "^5.9.1", "@typescript-eslint/parser": "^5.9.1", "dotenv": "^12.0.3", "eslint": "^8.6.0", "eslint-config-prettier": "^8.3.0", "eslint-plugin-prettier": "^4.0.0", "jest": "^27.4.7", "prettier": "^2.5.1", "size-limit": "^7.0.8", "ts-jest": "^27.1.3", "tsup": "^5.11.11", "typescript": "^4.5.5" }, "dependencies": { "isomorphic-fetch": "^3.0.0" }, "browser": { "isomorphic-fetch": false }, "size-limit": [ { "path": "dist/index.js", "limit": "5 KB" }, { "path": "dist/index.mjs", "limit": "5 KB" } ] }

package/README.md

@@ -1,63 +0,0 @@
-# Upstash Redis
-
-An HTTP/REST based Redis client built on top of [Upstash REST API](https://docs.upstash.com/features/restapi).
-
-[![Tests](https://github.com/upstash/upstash-redis/actions/workflows/test.yml/badge.svg)](https://github.com/upstash/upstash-redis/actions/workflows/test.yml)
-![npm (scoped)](https://img.shields.io/npm/v/@upstash/redis)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/@upstash/redis)
-
-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/cloudflare-workers))
-- Fastly Compute@Edge
-- Next.js, Jamstack ...
-- Client side web/mobile applications
-- WebAssembly
-- and other environments where HTTP is preferred over TCP.
-
-See [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility) supported.
-
-## Quick Start
-
-### Install
-
-```bash
-npm install @upstash/redis
-```
-
-### Usage with Promise
-
-```typescript
-import { auth, set } from '@upstash/redis';
-
-auth('UPSTASH_REDIS_REST_URL', 'UPSTASH_REDIS_REST_TOKEN');
-
-set('key', 'value').then(({ data }) => {
-  console.log(data);
-  // -> "OK"
-});
-```
-
-### Usage with async/await
-
-```typescript
-import { set } from '@upstash/redis';
-
-(async () => {
-  try {
-    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 skip the auth().
-
-## Docs
-
-See [the documentation](https://docs.upstash.com/features/javascriptsdk) for details.

package/dist/main/client.d.ts

@@ -1,21 +0,0 @@
-import { ClientObjectProps, Upstash } from './types';
-/**
- * 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: {} });
- * ```
- */
-declare function upstash(options?: ClientObjectProps): Upstash;
-declare function upstash(url?: string, token?: string): Upstash;
-export default upstash;