Interface: IgFlareOptions
Construction options for IgFlare.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
autoRelogin? | readonly | boolean | Re-authenticate automatically when the session expires: the credentials (and second-factor source) of the last login() are kept in this process's memory and replayed, then the rejected request is repeated once. Ignored when onSessionExpired is set, which takes precedence and keeps credentials out of the SDK. Has no effect for a session loaded from a store without a login(). | - |
onSessionExpired? | readonly | (error) => Promise<void> | Called when a request is rejected with login_required (the session expired). It should re-authenticate. The rejected request is then repeated once. Several requests failing together share one call, and requests the hook itself makes never trigger it again. | PrivateClientOptions.onSessionExpired |
proxy? | readonly | string | An HTTP or HTTPS proxy for every request, as http://user:password@host:port. It configures the default transport, so it cannot be combined with transport. | - |
retry? | readonly | false | RetryOptions | Retry policy. By default the transport is wrapped in a RetryTransport with conservative backoff. Pass tuning here, or false to disable retries (e.g. when supplying a transport that already retries). | - |
session? | readonly | SessionData | - | PrivateClientOptions.session |
store? | readonly | SessionStore | - | PrivateClientOptions.store |
transport? | readonly | HttpTransport | - | PrivateClientOptions.transport |