Interface ApiClientOptions

Hierarchy

Properties

baseURL? body? cache? credentials? fetch? headers hooks? ignoreSessionTokenHeader? info? integrity? json? keepalive? method? mode? parseJson? parseTypedJson? redirect? referrer? referrerPolicy? removeEmptySearchParamsValue? searchParams? sessionToken? sessionTokenHeaderName? signal? stringifyJson? stringifyTypedJson? throwHttpErrors? throwOnEmptyJson? timeout? treat404As204? typedJson? window?

Properties

Optional baseURL

baseURL?: string

Optional body

body?: null | BodyInit

A BodyInit object or null to set request's body.

Optional cache

cache?: RequestCache

A string indicating how the request will interact with the browser's cache to set request's cache.

Optional credentials

credentials?: RequestCredentials

A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

Optional fetch

fetch?: ((input: RequestInfo, init?: RequestInit) => Promise<Response>)

Type declaration

    • (input: RequestInfo, init?: RequestInit): Promise<Response>

    • Parameters

      • input: RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

headers

headers: Headers

Optional hooks

hooks?: Partial<Omit<HttpInterceptor<HttpOptions>, keyof Extension<ExtensionContext>>>[]

Optional ignoreSessionTokenHeader

ignoreSessionTokenHeader?: boolean

Optional info

info?: IStorage<unknown>

Optional integrity

integrity?: string

A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

Optional json

json?: unknown

Optional keepalive

keepalive?: boolean

A boolean to set request's keepalive.

Optional method

method?: string

A string to set request's method.

Optional mode

mode?: RequestMode

A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

Optional parseJson

parseJson?: ((text: string) => unknown)

Type declaration

    • (text: string): unknown

    • Parameters

      • text: string

      Returns unknown

Optional parseTypedJson

parseTypedJson?: ((text: string, useTypedField?: boolean) => unknown)

Type declaration

    • (text: string, useTypedField?: boolean): unknown

    • Parameters

      • text: string
      • Optional useTypedField: boolean

      Returns unknown

Optional redirect

redirect?: RequestRedirect

A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

Optional referrer

referrer?: string

A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

Optional referrerPolicy

referrerPolicy?: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

Optional removeEmptySearchParamsValue

removeEmptySearchParamsValue?: boolean

Optional searchParams

searchParams?: HttpSearchParams

Optional sessionToken

sessionToken?: string

Optional sessionTokenHeaderName

sessionTokenHeaderName?: string

Optional signal

signal?: null | AbortSignal

An AbortSignal to set request's signal.

Optional stringifyJson

stringifyJson?: ((obj: unknown) => string)

Type declaration

    • (obj: unknown): string

    • Parameters

      • obj: unknown

      Returns string

Optional stringifyTypedJson

stringifyTypedJson?: ((obj: unknown) => string)

Type declaration

    • (obj: unknown): string

    • Parameters

      • obj: unknown

      Returns string

Optional throwHttpErrors

throwHttpErrors?: boolean

Optional throwOnEmptyJson

throwOnEmptyJson?: boolean

Optional timeout

timeout?: number

Optional treat404As204

treat404As204?: boolean

Optional typedJson

typedJson?: unknown

Optional window

window?: null

Can only be null. Used to disassociate request from any Window.

Generated using TypeDoc