_api_.iapi.md

@directus/sdk-js

Globals / "API" / IAPI /

Interface: IAPI

Hierarchy

• IAPI

Implemented by

• API

Index

Properties

• auth
• concurrent
• xhr

Methods

• delete
• get
• getPayload
• patch
• post
• put
• request
• reset

Properties

auth

• auth: IAuthentication

Defined in API.ts:22

---

concurrent

• concurrent: ReturnType<concurrencyManager>

Defined in API.ts:24

---

xhr

• xhr: AxiosInstance

Defined in API.ts:23

Methods

delete

▸ delete<T>(endpoint: string): Promise<T>

Defined in API.ts:30

Type parameters:

▪ T: any

Parameters:

Name	Type
endpoint	string

Returns: Promise<T>

---

get

▸ get<T>(endpoint: string, params?: object): Promise<T>

Defined in API.ts:26

Type parameters:

▪ T: any

Parameters:

Name	Type
endpoint	string
params?	object

Returns: Promise<T>

---

getPayload

▸ getPayload<T>(): T

Defined in API.ts:31

Type parameters:

▪ T: object

Returns: T

---

patch

▸ patch<T>(endpoint: string, body?: BodyType, params?: object): Promise<T>

Defined in API.ts:28

Type parameters:

▪ T: any

Parameters:

Name	Type
endpoint	string
body?	BodyType
params?	object

Returns: Promise<T>

---

post

▸ post<T>(endpoint: string, body?: BodyType, params?: object): Promise<T>

Defined in API.ts:27

Type parameters:

▪ T: any

Parameters:

Name	Type
endpoint	string
body?	BodyType
params?	object

Returns: Promise<T>

---

put

▸ put<T>(endpoint: string, body?: BodyType, params?: object): Promise<T>

Defined in API.ts:29

Type parameters:

▪ T: any

Parameters:

Name	Type
endpoint	string
body?	BodyType
params?	object

Returns: Promise<T>

---

request

▸ request<T>(method: RequestMethod, endpoint: string, params?: object, data?: object, noProject?: boolean, headers?: object, skipParseToJSON?: boolean): Promise<T>

Defined in API.ts:32

Type parameters:

▪ T: any

Parameters:

Name	Type
method	RequestMethod
endpoint	string
params?	object
data?	object
noProject?	boolean
headers?	object
skipParseToJSON?	boolean

Returns: Promise<T>

---

reset

▸ reset(): void

Defined in API.ts:25

Returns: void