Interface SyncClientOptions

interface SyncClientOptions {
    baseUrl: string;
    fetch?: FetchLike;
    headers?: Record<string, string>;
    token?: string | AccessTokenSource | null;
}

Properties

baseUrl: string

{sync} from discovery (…/api/v1), or a self-hosted server's base URL (see selfHosted)

defaults to globalThis.fetch

headers?: Record<string, string>

extra headers for every request (e.g. User-Agent in Node)

token?: string | AccessTokenSource | null

a device token (legacy) or a JWT source (TokenManager / service account)