@types/hapi-auth-bearer-token

Installation

npm install --save @types/hapi-auth-bearer-token

Summary

This package contains type definitions for hapi-auth-bearer-token (https://github.com/johnbrett/hapi-auth-bearer-token).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hapi-auth-bearer-token.

index.d.ts

/// <reference types="node" />

import { AuthenticationData, Plugin, Request, ResponseToolkit } from "@hapi/hapi";

type ValidateReturn = AuthenticationData & { isValid: boolean };

declare module "@hapi/hapi" {
    interface ServerAuth {
        strategy(name: string, scheme: "bearer-access-token", options: BearerToken.SchemaOptions): void;
    }
}

declare namespace BearerToken {
    interface SchemaOptions {
        validate: Validate;
        accessTokenName?: string | undefined;
        allowQueryToken?: boolean | undefined;
        allowCookieToken?: boolean | undefined;
        allowMultipleHeaders?: boolean | undefined;
        allowChaining?: boolean | undefined;
        tokenType?: string | undefined;
        unauthorized?: ((message: string | null, scheme: string) => any) | undefined;
    }

    type Validate = (request: Request, token: string, h: ResponseToolkit) => Promise<ValidateReturn> | ValidateReturn;
}

declare var BearerToken: Plugin<{}>;

export = BearerToken;

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @hapi/hapi, @types/node, joi

Credits

These definitions were written by Rodrigo Saboya.