Skip to content

docs: use bundled package declarations in TypeScript instructions - #610

Merged
jaime-ez merged 1 commit into
deepstreamIO:masterfrom
dajiaohuang:docs/typescript-package-declarations-20261016
Oct 21, 2026
Merged

jaime-ez merged 1 commit into
deepstreamIO:masterfrom
dajiaohuang:docs/typescript-package-declarations-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown
Contributor

Summary

Replace the stale TypeScript typeRoots instructions with the package import and automatic declaration resolution.

The README currently points readers to node_modules/deepstream.io-client.js/src/client.d.ts. That package path and declaration file are not present in the current @deepstream/client package. Its types field already points to dist/src/deepstream-client.d.ts, so the custom typeRoots entry is unnecessary. The example uses the exported DeepstreamClient name.

Validation

  • Built and packed the current package, installed that tarball into a fresh local consumer with install scripts disabled, and compiled the documented import with TypeScript 4.9.5 (--strict --noEmit --target ES2020 --module commonjs --moduleResolution node), without custom typeRoots.
  • npm run lint
  • npm run test:coverage: 280 passing, 4 pending
  • npm run build
  • Exercised the exported client with an owned mocked socket: login, event subscription/emission, record reads/updates, list changes, and RPC request/provider responses.

Checks ran on Windows with Node 24.14.1. No real deepstream server/cloud endpoint, browser runtime, or React Native acceptance was exercised; this is a documentation-only change.

@jaime-ez
jaime-ez merged commit 45447e7 into deepstreamIO:master Oct 21, 2026
1 check passed
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