Skip to main content

NhostClient

Parameters


params required NhostReactClientConstructorParams

PropertyTypeRequiredNotes
params.adminSecretstringWhen set, the admin secret is sent as a header, x-hasura-admin-secret, for all requests to GraphQL, Storage, and Serverless Functions.
params.regionstringProject region (e.g. eu-central-1) Project region is not required during local development (when subdomain is localhost)
params.subdomainstringProject subdomain (e.g. ieingiwnginwnfnegqwvdqwdwq) Use localhost during local development
params.backendUrlstringNhost backend URL Will be deprecated in a future release. Please look at 'subdomain' and 'region' instead.
params.devToolsbooleanActivate devTools e.g. the ability to connect to the xstate inspector
params.autoSignInbooleanWhen set to true, will parse the url on startup to check if it contains a refresh token to start the session with
params.autoRefreshTokenbooleanWhen set to true, will automatically refresh token before it expires
params.clientStorageClientStorageObject where the refresh token will be persisted and read locally.
params.clientStorageTypeClientStorageTypeDefine a way to get information about the refresh token and its exipration date.
params.refreshIntervalTimenumberTime interval until token refreshes, in seconds