Type Alias LoginResult

LoginResult: {
    clientInfo: string | null;
    error: DittoError | null;
}

Represents the result of a login attempt.

Type declaration

  • clientInfo: string | null

    JSON-formatted client info returned by the authentication webhook, if any. This field is populated for both successful and failed login attempts and is only null when no client info was provided by the webhook.

    See Ditto's online documentation for more information on how to provide client info using an authentication webhook.

  • error: DittoError | null

    If the login attempt was successful, this property will be null. If the login attempt failed, this property will contain a DittoError object with details about the error.