Skip to content

docs: add server-side TypeScript connection lifecycle#5005

Closed
benpsnyder wants to merge 1 commit into
clockworklabs:masterfrom
benpsnyder:docs/server-side-ts-sdk-lifecycle
Closed

docs: add server-side TypeScript connection lifecycle#5005
benpsnyder wants to merge 1 commit into
clockworklabs:masterfrom
benpsnyder:docs/server-side-ts-sdk-lifecycle

Conversation

@benpsnyder
Copy link
Copy Markdown
Contributor

Summary

Refs #5004.

Adds server-side TypeScript lifecycle guidance for generated DbConnection usage from Node/server runtimes. This covers long-running connection managers, reconnect/resubscribe behavior, reducer calls from server handlers, token refresh by rebuilding connections, request-scoped/serverless snapshots, and an optional Effect v4 runtime pattern for testable services and CLI workflows.

Also adds TypeScript reference notes for Node.js runtime requirements, including Node 22 global WebSocket support and undici on Node 18-21.

Verification

  • git diff --check
  • pnpm --dir docs build with Node v22.22.2
  • pnpm --dir docs typecheck with Node v22.22.2

Build note: an initial workspace install failed under Node v26 and then under full workspace install due unrelated native/optional dependency install issues. A filtered docs install with scripts ignored succeeded, and the docs build/typecheck passed under Node v22.22.2.

@cloutiertyler
Copy link
Copy Markdown
Contributor

Hi @benpsnyder, thanks for your contribution to the docs. We don't accept draft PRs in our repo to keep our PRs relatively neat and manageable, so I'm going to close this for now, at least until you have a complete PR for us to review.

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.

2 participants