Interface AppSyncClientOptions

Constructor options for AppSyncClient.

interface AppSyncClientOptions {
    url: string;
    auth: AuthConfig;
    headers?: Readonly<Record<string, string>>;
    timeoutMs?: number;
    retry?: RetryOptions;
    fetch?: FetchLike;
    signal?: AbortSignal;
}

Properties

url auth headers? timeoutMs? retry? fetch? signal?

Properties

Readonlyurl

url: string

AppSync GraphQL endpoint, e.g. https://abc.appsync-api.us-east-1.amazonaws.com/graphql.

Readonlyauth

auth: AuthConfig

Authentication strategy. See AuthConfig.

Optional Readonlyheaders

headers?: Readonly<Record<string, string>>

Extra HTTP headers attached to every request.

Optional ReadonlytimeoutMs

timeoutMs?: number

Default request timeout in ms. Defaults to 30_000. 0 disables.

Optional Readonlyretry

retry?: RetryOptions

Default retry policy.

Optional Readonlyfetch

fetch?: FetchLike

Override the global fetch. Mostly useful for tests / edge runtimes.

Optional Readonlysignal

signal?: AbortSignal

Abort all in-flight requests.

Settings

Member Visibility

On This Page

Properties