Package Exports

@upstash/qstash
@upstash/qstash/cloudflare
@upstash/qstash/nextjs
@upstash/qstash/nodejs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@upstash/qstash) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Upstash qStash SDK

npm (scoped) npm bundle size

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)
Fastly Compute@Edge
Next.js, including edge
Deno
Client side web/mobile applications
WebAssembly
and other environments where HTTP is preferred over TCP.

See the list of APIs supported.

Status of the SDK

It is currently in beta and we are actively collecting feedback from the community. Please report any issues you encounter or feature requests in the GitHub issues or talk to us on Discord. Thank you!

How does qStash work?

qStash is the message broker between your serverless apps. You send aa HTTP request to qStash, that includes a destination, a payload and optional settings. We store your message durable 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

npm install @upstash/qstash

Deno

import { Client } from "https://deno.land/x/upstash_qstash/mod.ts";

Get your authorization token

Go to upstash and copy the token.

Basic Usage:

Publishing a message

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 c = new Client({
  token: "<QSTASH_TOKEN>",
});

const res = await c.publishJSON({
  destination: "https://my-api...",
  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.

import { Receiver } from "@upstash/qstash";

const r = new Receiver({
  currentSigningKey: "..",
  nextSigningKey: "..",
});

const isValid = await r.verify({
  /**
   * The signature from the `Upstash-Signature` header.
   */
  signature: "string";

  /**
   * The raw request body.
   */
  body: "string";
})

Docs

See the documentation for details.

JSPM

@upstash/qstash