Class: AuthHeader

@divine/headers.AuthHeader

Hierarchy

• AuthHeader

  ↳ Authorization

  ↳ AuthenticationInfo

  ↳ ServerAuthorization

  ↳ WWWAuthenticate

Constructors

constructor

• Protected new AuthHeader(unparsed, headerName)

Parameters

Name	Type
unparsed	string | AuthHeader
headerName	string

Defined in

headers/src/auth-headers.ts:40

Properties

credentials

• Optional Readonly credentials: string

Defined in

headers/src/auth-headers.ts:37

---

headerName

• Readonly headerName: string

Defined in

headers/src/auth-headers.ts:40

---

params

• Readonly params: AuthHeaderParams = {}

Defined in

headers/src/auth-headers.ts:38

Accessors

realm

• get realm(): undefined | string

Returns

undefined | string

Defined in

headers/src/auth-headers.ts:73

---

scheme

• get scheme(): string

Returns

string

Defined in

headers/src/auth-headers.ts:69

Methods

_formatParams

▸ Protected _formatParams(): string

Returns

string

Defined in

headers/src/auth-headers.ts:102

---

isProxyHeader

▸ isProxyHeader(): boolean

Returns

boolean

Defined in

headers/src/auth-headers.ts:98

---

param

▸ param(name): undefined | string

Parameters

Name	Type
name	string

Returns

undefined | string

Defined in

headers/src/auth-headers.ts:77

▸ param(name, fallback): string

Parameters

Name	Type
name	string
fallback	string

Returns

string

Defined in

headers/src/auth-headers.ts:78

---

setParam

▸ setParam(name, value, quoted?): AuthHeader

Parameters

Name	Type
name	string
value	undefined | string | number
quoted?	boolean

Returns

AuthHeader

Defined in

headers/src/auth-headers.ts:83

---

toString

▸ toString(): string

Returns

string

Defined in

headers/src/auth-headers.ts:94

---

split

▸ Static split(unparsed): string[]

Parameters

Name	Type
unparsed	string

Returns

string[]

Defined in

headers/src/auth-headers.ts:26