github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-25 03:00:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: update sdk imports (#19681)

Browse Source
This commit is contained in:
Esther Agbaje
2023-09-13 21:09:59 +01:00
committed by GitHub
parent b51c26d725
commit ac43a43223
1 changed files with 9 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/guides/sdk/getting-started.md
View File

@@ -59,9 +59,7 @@ For example, to create a client with REST or GraphQL support, use the following:
::: code-group
```js [JavaScript]
import { createDirectus } from '@directus/sdk';
import { rest } from '@directus/sdk/rest';
import { graphql } from '@directus/sdk/graphql';
import { createDirectus, rest, graphql } from '@directus/sdk';
// Client with REST support
const client = createDirectus('http://directus.example.com').with(rest());
@@ -71,9 +69,7 @@ const client = createDirectus('http://directus.example.com').with(graphql());
```
```ts [TypeScript]
import { createDirectus } from '@directus/sdk';
import { rest } from '@directus/sdk/rest';
import { graphql } from '@directus/sdk/graphql';
import { createDirectus, rest, graphql } from '@directus/sdk';
interface Article {
id: number;
@@ -105,8 +101,7 @@ Use the `authentication()` composable to add user login and tokens auto-refresh
For example, to login to your directus instance, invoke the `login` method
```js
import { createDirectus } from '@directus/sdk';
import { authentication } from '@directus/sdk/auth';
import { createDirectus, authentication } from '@directus/sdk';
const client = createDirectus('http://directus.example.com').with(authentication());
@@ -148,8 +143,7 @@ For example, to make a request to an `articles` collection.
#### Read a single item
```js
import { createDirectus } from '@directus/sdk';
import { rest, readItem } from '@directus/sdk/rest';
import { createDirectus, rest, readItem } from '@directus/sdk';
const client = createDirectus('http://directus.example.com').with(rest());
@@ -160,8 +154,7 @@ const result = await client.request(readItem('articles', article_id));
#### Read all items
```js
import { createDirectus } from '@directus/sdk';
import { rest, readItems } from '@directus/sdk/rest';
import { createDirectus, rest, readItems } from '@directus/sdk';
const client = createDirectus('http://directus.example.com').with(rest());
@@ -171,8 +164,7 @@ const result = await client.request(readItems('articles'));
#### Read specific fields
```js
import { createDirectus } from '@directus/sdk';
import { rest, readItems } from '@directus/sdk/rest';
import { createDirectus, rest, readItems } from '@directus/sdk';
const client = createDirectus('http://directus.example.com').with(rest());
@@ -186,8 +178,7 @@ const result = await client.request(
#### Read all fields
```js
import { createDirectus } from '@directus/sdk';
import { rest, readItems } from '@directus/sdk/rest';
import { createDirectus, rest, readItems } from '@directus/sdk';
const client = createDirectus('http://directus.example.com').with(rest());
@@ -201,8 +192,7 @@ const result = await client.request(
#### Read nested fields
```js
import { createDirectus } from '@directus/sdk';
import { rest, readItems } from '@directus/sdk/rest';
import { createDirectus, rest, readItems } from '@directus/sdk';
const client = createDirectus('http://directus.example.com').with(rest());
@@ -220,8 +210,7 @@ Add the `graphql()` composable to the client, this enables the `.query(...)` met
For example, to make a request to an `articles` collection with TypeScript:
```ts
import { createDirectus } from '@directus/sdk';
import { graphql } from '@directus/sdk/graphql';
import { createDirectus, graphql } from '@directus/sdk';
interface Article {
id: number;
@@ -246,12 +235,6 @@ const result = await client.query<Article[]>(`
`);
```
:::tip Importing SDK Composables
All SDK composables can also be conveniently imported from the root package `@directus/sdk`.
:::
## Global APIs
To keep the SDK dependency-free, it does rely on the APIs mentioned below, which originally came from the browser