Skip to main content

NhostClient

Parameters


params required NhostVueClientConstructorParams

PropertyTypeRequiredNotes
params.regionstringApp region (e.g., eu-central-1) Not required in development (when subdomain is "localhost")
params.subdomainstringApp subdomain (e.g, ieingiwnginwnfnegqwvdqwdwq) Should be used when using the Nhost platform Use "localhost" in development
params.adminSecretstringWhen set, the admin secret is sent as a header, x-hasura-admin-secret, for all requests to GraphQL, Storage, and Functions.
params.backendUrlstringNhost backend URL Should only be used when self-hosting
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