Skip to content
gymgym docs

GymClientOptions

Properties

Section titled “Properties”

baseUrl?

Section titled “baseUrl?”

optional baseUrl?: string

API origin, e.g. https://gymgym.club. Omit in the browser to use the current origin.

fetch?

Section titled “fetch?”

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

Custom fetch (tests, React Native, service bindings).

MDN Reference

Parameters

Section titled “Parameters”
input
Section titled “input”

RequestInfo | URL

init?
Section titled “init?”

RequestInit

Returns

Section titled “Returns”

Promise<Response>

headers?

Section titled “headers?”

optional headers?: Record<string, string>

Extra headers on every API request.

onMutation?

Section titled “onMutation?”

optional onMutation?: (operationName) => void

Called after every successful mutation, e.g. to invalidate caches.

Parameters

Section titled “Parameters”
operationName
Section titled “operationName”

string

Returns

Section titled “Returns”

void

storage?

Section titled “storage?”

optional storage?: QueueStorage

Where the offline queue persists; defaults to memory.

token?

Section titled “token?”

optional token?: string | (() => string | null | undefined)

Bearer token for clients without cookies (CLI, native apps). Read on every request.