AniLink - v3.0.0
    Preparing search index...

    Interface AniListTokenRefresherOptions

    The fields the AniList wiring passes to buildAniListTokenRefresher: the shared refresh-option shape with AniList's one narrowing, that the refresh grant requires the client secret, unlike MAL's optional one.

    buildAniListTokenRefresher

    interface AniListTokenRefresherOptions {
        applyAccessToken: (accessToken: string) => void;
        clientId: string;
        clientSecret: string;
        diagnostics?: DiagnosticsMode;
        onHookError?: OnHookErrorHandler;
        onTokenRefresh?: (response: AniListTokenResponse) => void;
        onTokenRefreshError?: (error: AniLinkError) => void;
        refreshToken: string;
    }

    Hierarchy (View Summary)

    Index
    applyAccessToken clientId clientSecret diagnostics? onHookError? onTokenRefresh? onTokenRefreshError? refreshToken
    applyAccessToken: (accessToken: string) => void

    Swaps the fresh access token onto the operation instances. Called between the refresh and the replay so the replayed request carries the new auth material. The callback must write through the wiring's live auth cell (not a construction-time snapshot) so both already- constructed operations and instances built later see the refreshed token.

    clientId: string

    The application client ID sent on the refresh grant.

    clientSecret: string

    The AniList application client secret, required by AniList's refresh grant.

    diagnostics?: DiagnosticsMode

    How a throwing onTokenRefresh callback with no observer is reported; defaults to "warn".

    onHookError?: OnHookErrorHandler

    Optional observer for onTokenRefresh failures, mirroring the transport hooks.

    onTokenRefresh?: (response: AniListTokenResponse) => void

    Optional callback invoked once after every successful refresh.

    onTokenRefreshError?: (error: AniLinkError) => void

    Optional callback invoked once when a refresh grant fails.

    refreshToken: string

    The stored refresh token exchanged for new access tokens.

    Settings
    Member Visibility

    On This Page
    Properties