Skip to content

docs: use bundled package declarations in TypeScript instructions #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jaime-ez merged 1 commit into from
Oct 21, 2026
Merged

docs: use bundled package declarations in TypeScript instructions #610

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ For tutorials see the [tutorial page](https://deepstreamio.github.io/docs/tutori

This repository comes with the Typescript typings bundled. No need to download them separately!

Make sure the `src/client.d.ts` file is accessible to the Typescript compiler. Do this by making sure it's an included file in tsconfig.json by adding a `typeRoots` defininition. (Required Typescript 2.0 or higher.)
Import the client from `@deepstream/client`; TypeScript resolves the bundled declarations through the package's `types` field. No custom `typeRoots` entry is needed.

> "typeRoots": [
"./node_modules/deepstream.io-client.js/src/client.d.ts"
]
```typescript
import { DeepstreamClient } from '@deepstream/client'
```

## Install in react-native

Expand Down
Loading