Type Alias InvokeFetchProperties

type InvokeFetchProperties = {
    body?: unknown;
    contentType?: string;
    method: string;
    options?: ApiCallOptions;
    pathTemplate: string;
    pathVariables?: Record<string, string>;
    query?: Record<string, unknown>;
    requestInitOverrides?: RequestInit;
    userAgent?: string;
}
Index

Properties

body?: unknown

data passed to api call

contentType?: string

specify what content-type to send, if omitted "application/json" is assumed

method: string

http method

options?: ApiCallOptions

additional api call options

pathTemplate: string

path to api endpoint, can be in a template format e.g. /api/v1/space/{spaceId}

pathVariables?: Record<string, string>

path variables to be used in the path template

query?: Record<string, unknown>

additional query to url

requestInitOverrides?: RequestInit

override default RequestInit options

userAgent?: string

override the default user-agent with this value. This will also override any browser's UA.