Parameters
params required
NhostClientConstructorParams
| Property | Type | Required | Notes |
|---|---|---|---|
| params.adminSecret | string | When set, the admin secret is sent as a header, x-hasura-admin-secret, for all requests to GraphQL, Storage, and Serverless Functions. | |
| params.functionsUrl | string | ||
| params.storageUrl | string | ||
| params.graphqlUrl | string | ||
| params.authUrl | string | ||
| params.region | string | Project region (e.g. eu-central-1) Project region is not required during local development (when subdomain is localhost) | |
| params.subdomain | string | Project subdomain (e.g. ieingiwnginwnfnegqwvdqwdwq) Use localhost during local development | |
| params.devTools | boolean | Activate devTools e.g. the ability to connect to the xstate inspector | |
| params.autoSignIn | boolean | When set to true, will parse the url on startup to check if it contains a refresh token to start the session with | |
| params.autoRefreshToken | boolean | When set to true, will automatically refresh token before it expires | |
| params.clientStorage | ClientStorage | Object where the refresh token will be persisted and read locally. | |
| params.clientStorageType | ClientStorageType | Define a way to get information about the refresh token and its exipration date. | |
| params.refreshIntervalTime | number | Time interval until token refreshes, in seconds | |
| params.start | boolean |