Appearance

On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / rest

Function: rest() ​

rest(config): <Schema>(client) => RestClient<Schema>

Creates a client to communicate with the Directus REST API.

Parameters ​

• config: Partial<RestConfig>= {}

Returns ​

Function

A Directus REST client.

Type parameters ​

• Schema extends object

Parameters ​

• client: DirectusClient<Schema>

Returns ​

RestClient<Schema>

Source ​

rest/composable.ts:14