Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upstash/redis-js
HTTP based Redis Client for Serverless and Edge Functions
https://github.com/upstash/redis-js
redis serverless upstash upstash-sdk
Last synced: 3 days ago
JSON representation
HTTP based Redis Client for Serverless and Edge Functions
- Host: GitHub
- URL: https://github.com/upstash/redis-js
- Owner: upstash
- License: mit
- Created: 2021-08-09T21:03:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T23:39:35.000Z (about 1 month ago)
- Last Synced: 2024-12-13T11:03:41.258Z (10 days ago)
- Topics: redis, serverless, upstash, upstash-sdk
- Language: TypeScript
- Homepage: https://docs.upstash.com/redis
- Size: 2.17 MB
- Stars: 710
- Watchers: 11
- Forks: 56
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Upstash Redis
`@upstash/redis` is an HTTP/REST based Redis client for typescript, built on top
of [Upstash REST API](https://docs.upstash.com/features/restapi).
[](https://github.com/upstash/upstash-redis/actions/workflows/tests.yaml)
> [!NOTE]
> **This project is in GA Stage.**
>
> The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes. The Upstash team is committed to maintaining and improving its functionality.
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/main/examples/cloudflare-workers))
- Fastly Compute@Edge (see
[the example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly))
- Next.js, Jamstack ...
- Client side web/mobile applications
- WebAssembly
- and other environments where HTTP is preferred over TCP.
See
[the list of APIs](https://upstash.com/docs/redis/overall/rediscompatibility)
supported.
## Quick Start
### Install
#### Node.js
```bash
npm install @upstash/redis
```
#### Deno
```ts
import { Redis } from "https://esm.sh/@upstash/redis";
```
### Create database
Create a new redis database on [upstash](https://console.upstash.com/)
## Basic Usage:
```ts
import { Redis } from "@upstash/redis"
const redis = new Redis({
url: ,
token: ,
})
// string
await redis.set('key', 'value');
let data = await redis.get('key');
console.log(data)
await redis.set('key3', 'value3', {ex: 1});
// sorted set
await redis.zadd('scores', { score: 1, member: 'team1' })
data = await redis.zrange('scores', 0, 100 )
console.log(data)
// list
await redis.lpush('elements', 'magnesium')
data = await redis.lrange('elements', 0, 100 )
console.log(data)
// hash
await redis.hset('people', {name: 'joe'})
data = await redis.hget('people', 'name' )
console.log(data)
// sets
await redis.sadd('animals', 'cat')
data = await redis.spop('animals', 1)
console.log(data)
```
## Troubleshooting
We have a
[dedicated page](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting)
for common problems. If you can't find a solution, please
[open an issue](https://github.com/upstash/upstash-redis/issues/new).
## Docs
See [the documentation](https://upstash.com/docs/redis/sdks/ts/overview) for
details.
## Contributing
### [Install Bun](https://bun.sh/docs/installation)
### Database
Create a new redis database on [upstash](https://console.upstash.com/) and copy
the url and token
### Running tests
```sh
bun run test
```
### Building
```sh
bun run build
```
### Telemetry
This library sends anonymous telemetry data to help us improve your experience.
We collect the following:
- SDK version
- Platform (Deno, Cloudflare, Vercel)
- Runtime version ([email protected])
You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
to any truthy value.
```sh
UPSTASH_DISABLE_TELEMETRY=1
```