Skip to content

ApiRequestOptions

ApiRequestOptions<T>: object

Type Parameters

T = unknown

Type declaration

body?

readonly optional body: any

cookies?

readonly optional cookies: Record<string, unknown>

errors?

readonly optional errors: Record<number | string, string>

formData?

readonly optional formData: Record<string, unknown>

headers?

readonly optional headers: Record<string, unknown>

mediaType?

readonly optional mediaType: string

method

readonly method: "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD" | "PATCH"

path?

readonly optional path: Record<string, unknown>

query?

readonly optional query: Record<string, unknown>

responseHeader?

readonly optional responseHeader: string

responseTransformer()?

readonly optional responseTransformer: (data) => Promise<T>

Parameters

data: unknown

Returns

Promise<T>

url

readonly url: string

Defined in

packages/core/src/ApiRequestOptions.ts:1