DatalayerRequest

Datalayer Core

---

Datalayer Core / DatalayerRequest

Interface: DatalayerRequest

Defined in: tech/datalayer/core/src/hooks/useDatalayer.ts:32

Options for Datalayer API requests.

Extends

• IDatalayerRequestProps.IRequestDatalayerAPIOptions

Properties

body?

optional body: any

Defined in: tech/datalayer/core/src/api/DatalayerApi.ts:127

Request body (JSON object or FormData)

Inherited from

IRequestDatalayerAPIOptions.body

---

headers?

optional headers: Record<string, string>

Defined in: tech/datalayer/core/src/api/DatalayerApi.ts:129

Custom HTTP headers

Inherited from

IRequestDatalayerAPIOptions.headers

---

loginRoute?

optional loginRoute: string

Defined in: tech/datalayer/core/src/hooks/useDatalayer.ts:23

React router login route

Default

'/login'

Inherited from

IDatalayerRequestProps.loginRoute

---

method?

optional method: string

Defined in: tech/datalayer/core/src/api/DatalayerApi.ts:125

HTTP method (GET, POST, PUT, DELETE, etc.)

Inherited from

IRequestDatalayerAPIOptions.method

---

notifyOnError?

optional notifyOnError: boolean

Defined in: tech/datalayer/core/src/hooks/useDatalayer.ts:29

Notify user through toast on errors.

Default

true

Inherited from

IDatalayerRequestProps.notifyOnError

---

signal?

optional signal: AbortSignal

Defined in: tech/datalayer/core/src/api/DatalayerApi.ts:133

AbortSignal for request cancellation

Inherited from

IRequestDatalayerAPIOptions.signal

---

token?

optional token: string

Defined in: tech/datalayer/core/src/api/DatalayerApi.ts:131

JWT bearer token for authentication

Inherited from

IRequestDatalayerAPIOptions.token

---

url

url: string

Defined in: tech/datalayer/core/src/api/DatalayerApi.ts:123

Target URL for the request

Inherited from

IRequestDatalayerAPIOptions.url