Variable spendRefreshToken

Type Declaration

• • (
        opts: any,
    ): Promise<
        | {
            description: string;
            error: string;
            errorCode: string;
            ok: boolean;
            requirement: string;
            revoke: any[];
            status: number;
        }
        | {
            clientId?: undefined;
            description?: undefined;
            error?: undefined;
            errorCode?: undefined;
            family?: undefined;
            handle?: undefined;
            ok: boolean;
            requirement?: undefined;
            revoke?: undefined;
        }
        | {
            clientId: string;
            description: string;
            error: string;
            errorCode: string;
            family: string;
            handle?: undefined;
            ok: boolean;
            requirement: string;
            revoke: any[];
        }
        | {
            clientId?: undefined;
            description?: undefined;
            error?: undefined;
            errorCode?: undefined;
            family?: undefined;
            handle: any;
            ok: boolean;
            requirement?: undefined;
            revoke?: undefined;
        },
    >

  • Redeems a refresh token once across the cluster while rotation is required; a no-op otherwise. Never rejects.

    Parameters

    • opts: any

      claims (the token's) and res

    Returns Promise<
        | {
            description: string;
            error: string;
            errorCode: string;
            ok: boolean;
            requirement: string;
            revoke: any[];
            status: number;
        }
        | {
            clientId?: undefined;
            description?: undefined;
            error?: undefined;
            errorCode?: undefined;
            family?: undefined;
            handle?: undefined;
            ok: boolean;
            requirement?: undefined;
            revoke?: undefined;
        }
        | {
            clientId: string;
            description: string;
            error: string;
            errorCode: string;
            family: string;
            handle?: undefined;
            ok: boolean;
            requirement: string;
            revoke: any[];
        }
        | {
            clientId?: undefined;
            description?: undefined;
            error?: undefined;
            errorCode?: undefined;
            family?: undefined;
            handle: any;
            ok: boolean;
            requirement?: undefined;
            revoke?: undefined;
        },
    >

    a promise of { ok: true, handle }, or a refusal in checkRefreshRequest()'s shape with revoke