Getting Started

​

Install

​

NPM

npm install @upstash/qstash

​

Get QStash token

Follow the instructions here to get your QStash token and signing keys.

​

Usage

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

const client = new Client({
  token: "<QSTASH_TOKEN>",
});

​

RetryConfig

You can configure the retry policy of the client by passing the configuration to the client constructor.

Note: This is for sending the request to QStash, not for the retry policy of QStash.

The default number of attempts is 6 and the default backoff function is (retry_count) => (Math.exp(retry_count) * 50).

You can also pass in false to disable retrying.

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

const client = new Client({
  token: "<QSTASH_TOKEN>",
  retry: {
    retries: 3,
    backoff: retry_count => 2 ** retry_count * 20,
  },
});