Skip to content

docs(qstash): document optional token and Client.fromEnv - #788

Draft
ytkimirti wants to merge 2 commits into
mainfrom
DX-2923-fromenv
Draft

docs(qstash): document optional token and Client.fromEnv#788
ytkimirti wants to merge 2 commits into
mainfrom
DX-2923-fromenv

Conversation

@ytkimirti

Copy link
Copy Markdown
Collaborator

DX-2923

The QStash TS client's token is optional (it falls back to QSTASH_TOKEN / region-prefixed env vars), and Client.fromEnv() was added to fail fast instead of warning. Neither was documented.

Adds a short section to qstash/sdks/ts/gettingstarted.mdx under Usage covering both, plus the Cloudflare Workers caveat (fromEnv reads process.env) and a pointer to the existing Local development section for the no-credentials path.

Pairs with the SDK change in upstash/qstash-js (branch DX-2923-dev-mode-no-credential-error).

@mintlify

mintlify Bot commented Aug 25, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
upstash 🟢 Ready View Preview Aug 25, 2026, 6:47 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@linear-code

linear-code Bot commented Aug 25, 2026

Copy link
Copy Markdown

DX-2923

@context7

context7 Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Docs7 for upstash.com

Build Commit Updated (UTC)
Failed — 2 documentation pages failed to build 15d2c0a 2026-08-26 11:03

Open build details

Review

Waiting for the review.

@context7
context7 Bot temporarily deployed to Docs7 Preview: DX-2923-fromenv August 25, 2026 06:46 Destroyed
@context7

context7 Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Docs7 review for upstash.com · 15d2c0a

No problems found.

Open this review on Docs7

@ytkimirti
ytkimirti marked this pull request as draft August 25, 2026 08:02
@ytkimirti

Copy link
Copy Markdown
Collaborator Author

Marking draft: Client.fromEnv() does not exist in any published @upstash/qstash (latest is 2.11.3). It ships with upstash/qstash-js branch DX-2923-dev-mode-no-credential-error, which isn't merged yet.

The other half of this PR (token is optional, client falls back to QSTASH_TOKEN/region-prefixed env vars) has been true since #222 in Feb 2025, so that part is accurate against 2.11.3 today.

Ready to merge once the SDK release lands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant