Type Alias AuthenticationExpirationHandler

AuthenticationExpirationHandler: ((ditto: Ditto, timeUntilExpiration: number) => Promise<any> | any)

A function type that handles authentication expiration events for Ditto.

This handler is called when the authentication for a Ditto instance has or is about to expire, or if authentication has not yet occurred. It provides the relevant Ditto instance and the time interval (in seconds) until expiration. You can use this to login or to perform other necessary actions before authentication expires.

Important: This API is in preview as an alternative to the phased out AuthenticationHandler interface in v5.

Important: When using server connections (i.e. DittoConfigConnectServer), you must set an expiration handler via ditto.auth.setExpirationHandler() . Otherwise, Ditto.startSync() will throw DittoError with code authentication/expiration-handler-missing.

Type declaration

    • (ditto, timeUntilExpiration): Promise<any> | any

    • Parameters

      • ditto: Ditto

        The Ditto instance whose authentication is expiring.

      • timeUntilExpiration: number

        The time interval, in seconds, until authentication expires.

      Returns Promise<any> | any

Settings

Member Visibility