@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

// Type definitions for hapi-auth-bearer-token 6.1
// Project: https://github.com/johnbrett/hapi-auth-bearer-token
// Definitions by: Rodrigo Saboya <https://github.com/saboya>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

import {
    Request,
    Plugin,
    ResponseToolkit,
    AuthenticationData,
  } 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: Wed, 21 Dec 2022 20:32:53 GMT
• Dependencies: @types/hapi__hapi
• Global values: none

Credits

These definitions were written by Rodrigo Saboya.