Skip to content

docs: improve clarity for typescript + sdk #664

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
ComfortablyCoding merged 5 commits into from
Jun 5, 2026
Merged

docs: improve clarity for typescript + sdk #664

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a46300
docs: improve clarity for typescript + sdk
kheiner Apr 25, 2026
e01fa44
Apply suggestion from @ComfortablyCoding
ComfortablyCoding Jun 5, 2026
2615250
Merge branch 'main' into pr/664
ComfortablyCoding Jun 5, 2026
de90d9a
remove fmt
ComfortablyCoding Jun 5, 2026
c880b1c
Fix tabs
ComfortablyCoding Jun 5, 2026
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
15 changes: 9 additions & 6 deletions content/guides/04.connect/6.sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ The Directus SDK is a "Composable Client" that allows you to customize and build
| `realtime()` | Adds `.connect()`, `.subscribe()`, `.sendMessage()`, and `.onWebSocket()` methods. Also adds reconnect logic. |
| `staticToken()` | Adds `.setToken()` and `.getToken()` methods for manually managing tokens. |

::tabs
::div{class="pr-6"}
::::tabs
:::div{class="pr-6"}
---
label: JavaScript
---
```js
import { createDirectus, rest } from '@directus/sdk';
const directus = createDirectus('http://directus.example.com').with(rest());
```
::
:::

::div{class="pr-6"}
:::div{class="pr-6"}
---
label: TypeScript
---
Expand All @@ -56,8 +56,10 @@ The Directus SDK is a "Composable Client" that allows you to customize and build
```

::callout{icon="i-lucide-graduation-cap" color="secondary" to="/tutorials/tips-and-tricks/advanced-types-with-the-directus-sdk"}
Learn how to create a Schema for SDK client creation.
::
Learn how to leverage TypeScript with the SDK for auto-completion and generated output types.
::
:::
::::


## Making Requests
Expand Down Expand Up @@ -135,6 +137,7 @@ To call custom endpoints using the SDK, you can manually provide a path and meth
method: 'GET',
}));
```
::
::

### GraphQL Usage
Expand Down
Loading