auth-vir - v3.1.0
    Preparing search index...

    Type Alias BackendAuthClientConfig<DatabaseUser, UserId, AssumedUserParams>

    BackendAuthClientConfig: Readonly<
        {
            csrf: Readonly<CsrfHeaderNameOption>;
            getJwtKeys: () => MaybePromise<Readonly<RawJwtKeys>>;
            getUserFromDatabase: (
                userParams: {
                    assumingUser: AssumedUserParams | undefined;
                    isSignUpCookie: boolean;
                    requestHeaders: Readonly<IncomingHttpHeaders>;
                    userId: UserId;
                },
            ) => MaybePromise<DatabaseUser | undefined | null>;
            isDev: boolean;
            serviceOrigin: string;
        } & PartialWithUndefined<
            {
                allowedClockSkew: Readonly<AnyDuration>;
                assumedUserHeaderName: string;
                assumeUser: {
                    canAssumeUser: (originalUser: DatabaseUser) => MaybePromise<boolean>;
                    parseAssumedUserHeaderValue: (
                        data: string,
                    ) => MaybePromise<
                        { assumedUserParams: AssumedUserParams; userId: UserId }
                        | undefined,
                    >;
                };
                log?: (message: string, extraData: AnyObject) => void;
                maxSessionDuration: Readonly<AnyDuration>;
                sessionRefreshStartTime: Readonly<AnyDuration>;
                userSessionIdleTimeout: Readonly<AnyDuration>;
                enableLogging(
                    params: {
                        assumedUserParams: AssumedUserParams | undefined;
                        user: DatabaseUser | undefined;
                        userId: UserId | undefined;
                    },
                ): boolean;
                generateServiceOrigin(
                    params: { requestHeaders: Readonly<IncomingHttpHeaders> },
                ): MaybePromise<string | undefined>;
            },
        >,
    >

    Config for BackendAuthClient.

    Type Parameters

    • DatabaseUser extends AnyObject
    • UserId extends string | number
    • AssumedUserParams extends JsonCompatibleObject = EmptyObject