kaven-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • userName: string
    • password: string

    Returns KavenAuthentication

Properties

Abstract Name

Name: string

Password

Password: string

Realm

Realm: string = "Kaven Basic Authentication"

A string to be displayed to users so they know which username and password to use.

This string should contain at least the name of the host performing the authentication and might additionally indicate the collection of users who might have access.

RequestHandler

RequestHandler: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>> = ...

UserName

UserName: string

Methods

Abstract Authenticate

  • Authenticate(res: Response<any, Record<string, any>>): void

  • Parameters

    • res: Response<any, Record<string, any>>

    Returns void

Abstract CheckCredentials

  • CheckCredentials(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): boolean

  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

    Returns boolean

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Class
  • Constructor
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc