Skip to main content

Class: AuthenticationInfo

@divine/headers.AuthenticationInfo

Hierarchy

Constructors

constructor

new AuthenticationInfo(unparsed, proxy?)

Parameters

NameTypeDefault value
unparsedstring | AuthenticationInfoundefined
proxybooleanfalse

Overrides

AuthHeader.constructor

Defined in

headers/src/auth-headers.ts:131

Properties

credentials

Optional Readonly credentials: string

Inherited from

AuthHeader.credentials

Defined in

headers/src/auth-headers.ts:37


headerName

Readonly headerName: string

Inherited from

AuthHeader.headerName

Defined in

headers/src/auth-headers.ts:40


params

Readonly params: AuthHeaderParams = {}

Inherited from

AuthHeader.params

Defined in

headers/src/auth-headers.ts:38

Accessors

realm

get realm(): undefined | string

Returns

undefined | string

Inherited from

AuthHeader.realm

Defined in

headers/src/auth-headers.ts:73


scheme

get scheme(): string

Returns

string

Inherited from

AuthHeader.scheme

Defined in

headers/src/auth-headers.ts:69

Methods

_formatParams

Protected _formatParams(): string

Returns

string

Inherited from

AuthHeader._formatParams

Defined in

headers/src/auth-headers.ts:102


isProxyHeader

isProxyHeader(): boolean

Returns

boolean

Inherited from

AuthHeader.isProxyHeader

Defined in

headers/src/auth-headers.ts:98


param

param(name): undefined | string

Parameters

NameType
namestring

Returns

undefined | string

Inherited from

AuthHeader.param

Defined in

headers/src/auth-headers.ts:77

param(name, fallback): string

Parameters

NameType
namestring
fallbackstring

Returns

string

Inherited from

AuthHeader.param

Defined in

headers/src/auth-headers.ts:78


setParam

setParam(name, value, quoted?): AuthenticationInfo

Parameters

NameType
namestring
valueundefined | string | number
quoted?boolean

Returns

AuthenticationInfo

Inherited from

AuthHeader.setParam

Defined in

headers/src/auth-headers.ts:83


toString

toString(): string

Returns

string

Inherited from

AuthHeader.toString

Defined in

headers/src/auth-headers.ts:94


create

Static create(unparsed): AuthenticationInfo

Parameters

NameType
unparsedstring | AuthenticationInfo

Returns

AuthenticationInfo

Defined in

headers/src/auth-headers.ts:125

Static create(unparsed): undefined | AuthenticationInfo

Parameters

NameType
unparsedundefined | string | AuthenticationInfo

Returns

undefined | AuthenticationInfo

Defined in

headers/src/auth-headers.ts:126


split

Static split(unparsed): string[]

Parameters

NameType
unparsedstring

Returns

string[]

Inherited from

AuthHeader.split

Defined in

headers/src/auth-headers.ts:26