Sporades SDK API
    Preparing search index...

    Type Alias AuthApi

    Browser auth API.

    The SDK stores the Sporades session token in localStorage and sends it over the same-origin client transport. Provider SDKs are not exposed to app code.

    type AuthApi = {
        confirmPasswordReset(
            code: string,
            newPassword: string,
        ): Promise<SporadesResult<{ ok: boolean }>>;
        get(): Promise<SporadesResult<AuthResult>>;
        sendPasswordResetLink(
            email: string,
        ): Promise<SporadesResult<{ ok: boolean }>>;
        setPassword(
            email: string,
            currentPassword: string,
            newPassword: string,
        ): Promise<SporadesResult<{ ok: boolean }>>;
        signIn(
            provider: "email",
            credentials: EmailCredentials,
        ): Promise<SporadesResult<unknown>>;
        signIn(
            provider: string,
            credentials?: unknown,
        ): Promise<SporadesResult<unknown>>;
        signOut(): Promise<SporadesResult<{ ok: boolean }>>;
        signUp(
            provider: "email",
            credentials: EmailCredentials,
        ): Promise<SporadesResult<unknown>>;
        signUp(
            provider: string,
            credentials?: unknown,
        ): Promise<SporadesResult<unknown>>;
        subscribe(listener: (state: AuthObserverState) => void): Subscription;
        verifyPasswordResetCode(
            code: string,
        ): Promise<SporadesResult<{ email: string }>>;
    }
    Index
    confirmPasswordReset get sendPasswordResetLink setPassword signIn signOut signUp subscribe verifyPasswordResetCode

    • Spend a Reset code and set the new password. This does not sign the browser in: sign in with the new password afterwards.

      Parameters

      • code: string
      • newPassword: string

      Returns Promise<SporadesResult<{ ok: boolean }>>

    • Ask the runtime to mail a password reset link.

      Resolves the same way whether or not the email is registered, so the reply cannot be used to discover which addresses have accounts.

      Parameters

      • email: string

      Returns Promise<SporadesResult<{ ok: boolean }>>

    • Change the signed-in email credential after verifying its current password.

      Parameters

      • email: string
      • currentPassword: string
      • newPassword: string

      Returns Promise<SporadesResult<{ ok: boolean }>>

    • Report which account a Reset code belongs to, so a reset page can name it. Does not spend the code, so a mail scanner following the link first does not break it for the recipient.

      Parameters

      • code: string

      Returns Promise<SporadesResult<{ email: string }>>

    Settings
    Member Visibility

    On This Page
    Methods