The options for the Hanko class
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
timeout |
number
|
<optional> |
The http request timeout in milliseconds. Defaults to 13000ms |
cookieName |
string
|
<optional> |
The name of the session cookie set from the SDK. Defaults to "hanko" |
cookieDomain |
string
|
<optional> |
The domain where the cookie set from the SDK is available. Defaults to the domain of the page where the cookie was created. |
cookieSameSite |
string
|
<optional> |
Specify whether/when cookies are sent with cross-site requests. Defaults to "lax". |
localStorageKey |
string
|
<optional> |
The prefix / name of the local storage keys. Defaults to "hanko" |
lang |
string
|
<optional> |
Used to convey the preferred language to the API, e.g. for translating outgoing emails. It is transmitted to the API in a custom header (X-Language). Should match one of the supported languages ("bn", "de", "en", "fr", "it, "pt-BR", "zh") if email delivery by Hanko is enabled. If email delivery by Hanko is disabled and the relying party configures a webhook for the "email.send" event, then the set language is reflected in the payload of the token contained in the webhook request. |