Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/upstash/qstash-js
Message queue for serverless
https://github.com/upstash/qstash-js
qstash sdk-js upstash upstash-sdk
Last synced: 5 days ago
JSON representation
Message queue for serverless
- Host: GitHub
- URL: https://github.com/upstash/qstash-js
- Owner: upstash
- License: mit
- Created: 2022-06-14T08:54:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T11:43:31.000Z (9 days ago)
- Last Synced: 2024-10-25T14:34:24.983Z (9 days ago)
- Topics: qstash, sdk-js, upstash, upstash-sdk
- Language: TypeScript
- Homepage: https://docs.upstash.com/qstash
- Size: 2.74 MB
- Stars: 163
- Watchers: 5
- Forks: 17
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Upstash QStash SDK
> [!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.
**QStash** is an HTTP based messaging and scheduling solution for serverless and
edge runtimes.
It is 100% built on stateless HTTP requests and designed for:
- Serverless functions (AWS Lambda ...)
- Cloudflare Workers (see
[the example](https://github.com/upstash/sdk-qstash-ts/tree/main/examples/cloudflare-workers))
- Fastly Compute@Edge
- Next.js, including [edge](https://nextjs.org/docs/api-reference/edge-runtime)
- Deno
- Client side web/mobile applications
- WebAssembly
- and other environments where HTTP is preferred over TCP.
## How does QStash work?
QStash is the message broker between your serverless apps. You send an HTTP
request to QStash, that includes a destination, a payload and optional settings.
We durably store your message and will deliver it to the destination API via
HTTP. In case the destination is not ready to receive the message, we will retry
the message later, to guarentee at-least-once delivery.
## Quick Start
### Install
#### npm
```bash
npm install @upstash/qstash
```
### Get your authorization token
Go to [Upstash Console](https://console.upstash.com/qstash) and copy the QSTASH_TOKEN.
## Basic Usage:
### Publishing a message
```ts
import { Client } from "@upstash/qstash";
/**
* Import a fetch polyfill only if you are using node prior to v18.
* This is not necessary for nextjs, deno or cloudflare workers.
*/
import "isomorphic-fetch";
const client = new Client({
token: "",
});
const res = await client.publishJSON({
url: "https://my-api...",
// or urlGroup: "the name or id of a url group"
body: {
hello: "world",
},
});
console.log(res);
// { messageId: "msg_xxxxxxxxxxxxxxxx" }
```
### Receiving a message
How to receive a message depends on your http server. The `Receiver.verify`
method should be called by you as the first step in your handler function.
```ts
import { Receiver } from "@upstash/qstash";
const r = new Receiver({
currentSigningKey: "..",
nextSigningKey: "..",
});
const isValid = await r.verify({
/**
* The signature from the `Upstash-Signature` header.
*
* Please note that on some platforms (e.g. Vercel or Netlify) you might
* receive the header in lower case: `upstash-signature`
*
*/
signature: "string";
/**
* The raw request body.
*/
body: "string";
})
```
### Publishing a message to an LLM provider
No need for complicated setup your LLM request. We'll call LLM and schedule it for your serverless needs.
```ts
import { Client, openai } from "@upstash/qstash";
const client = new Client({
token: "",
});
const result = await client.publishJSON({
api: { name: "llm", provider: openai({ token: process.env.OPENAI_API_KEY! }) },
body: {
model: "gpt-3.5-turbo",
messages: [
{
role: "user",
content: "Where is the capital of Turkey?",
},
],
},
callback: "https://oz.requestcatcher.com/",
});
```
## Docs
See [the documentation](https://docs.upstash.com/qstash) for details.
## Contributing
### Setup
This project requires [Bun](https://bun.sh/) to be installed. Please see the [Bun installation documentation](https://bun.sh/docs/installation) for further instructions.
Once you have cloned the project, you will need to install the dependencies and then you can run the project.
```sh
bun install
bun run build
```
### Testing
To begin testing, environment variables will need to be setup. First, create a `.env` file in the root of the project. [`.env.template`](/.env.template) can be used as a template. Your values can be found in the [Qstash Console](https://console.upstash.com/qstash).
```sh
bun run test
```
### Committing
This project uses [commitlint](https://commitlint.js.org/). When committing, please ensure your commit message is formatted to include an appropriate prefix with the message.
#### Examples
```
fix: typescript bug
feat: use new logger
perf: refactor cache
```
For a full list of options, please see the [`commitlint.config.js`](/commitlint.config.js) file.