• management
• SDK
• Args

Interface Args

interface Args {
url: string;
method: string;
contentType?: string;
headers?: Record<string, unknown>;
queryParameters?: Record<string, unknown>;
queryString?: string;
body?: unknown;
timeoutMs?: number;
maxRetries?: number;
withCredentials?: boolean;
abortSignal?: AbortSignal;
requestType?: "bytes" | "json" | "file" | "form" | "other";
responseType?:
| "arrayBuffer"
| "blob"
| "json"
| "text"
| "binary-response"
| "sse"
| "streaming";
duplex?: "half";
endpointMetadata?: EndpointMetadata;
fetchFn?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
};
logging?: LogConfig
| Logger;
}

Index

Properties

urlmethodcontentType?headers?queryParameters?queryString?body?timeoutMs?maxRetries?withCredentials?abortSignal?requestType?responseType?duplex?endpointMetadata?fetchFn?logging?

Properties

url

url: string

method

method: string

OptionalcontentType

contentType?: string

Optionalheaders

headers?: Record<string, unknown>

Optional DeprecatedqueryParameters

queryParameters?: Record<string, unknown>

Prefer queryString (produced by core.url.queryBuilder()). Retained for backwards compatibility with custom fetchers and callers that still construct request args with a query-parameter object.

OptionalqueryString

queryString?: string

Optionalbody

body?: unknown

OptionaltimeoutMs

timeoutMs?: number

OptionalmaxRetries

maxRetries?: number

OptionalwithCredentials

withCredentials?: boolean

OptionalabortSignal

abortSignal?: AbortSignal

OptionalrequestType

requestType?: "bytes" | "json" | "file" | "form" | "other"

OptionalresponseType

responseType?:
| "arrayBuffer"
| "blob"
| "json"
| "text"
| "binary-response"
| "sse"
| "streaming"

Optionalduplex

duplex?: "half"

OptionalendpointMetadata

endpointMetadata?: EndpointMetadata

OptionalfetchFn

fetchFn?: {
(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
(input: string | Request | URL, init?: RequestInit): Promise<Response>;
}

Type Declaration

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

MDN Reference

Parameters

- input: RequestInfo | URL
- `Optional`init: RequestInit

Returns Promise<Response>

• (input: string | Request | URL, init?: RequestInit): Promise<Response>

MDN Reference

Parameters

- input: string | Request | URL
- `Optional`init: RequestInit

Returns Promise<Response>

Optionallogging

logging?: LogConfig | Logger

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties urlmethodcontentTypeheadersqueryParametersqueryStringbodytimeoutMsmaxRetrieswithCredentialsabortSignalrequestTyperesponseTypeduplexendpointMetadatafetchFnlogging