Class Headers

HTTP header class.

Hierarchy

Headers

Index

Constructors

Properties

_headers? _init

Methods

_getHeaders append clone dehop get getAll getLinks remove set setLinks toArray toObject toString

Constructors

constructor

new Headers(init?: string[]): Headers
Parameters
- init: string[] = []
Returns Headers
- Defined in mojo.js-main/src/headers.ts:23

Properties

`Optional` _headers

_headers?: HeaderBuffer

_init

_init: string[]

Methods

_getHeaders

_getHeaders(): HeaderBuffer
Returns HeaderBuffer
- Defined in mojo.js-main/src/headers.ts:172

append

append(name: string, value: string): Headers
Append header value.
Parameters
- name: string
- value: string
Returns Headers
- Defined in mojo.js-main/src/headers.ts:30

clone

clone(): Headers
Clone headers.

Returns Headers
- Defined in mojo.js-main/src/headers.ts:47

dehop

dehop(): Headers
Remove hop-by-hop headers that should not be retransmitted.

Returns Headers
- Defined in mojo.js-main/src/headers.ts:54

get

get(name: string): null | string
Get header value.
Parameters
- name: string
Returns null | string
- Defined in mojo.js-main/src/headers.ts:63

getAll

getAll(name: string): string[]
Get all headers values individually.
Parameters
- name: string
Returns string[]
- Defined in mojo.js-main/src/headers.ts:72

getLinks

getLinks(): Record<string, Record<string, string>>
Get web links from Link header according to RFC5988.

Link
http://tools.ietf.org/html/rfc5988

Example
```
// Extract information about next page
const {link, title} = headers.getLinks().next;
```
Returns Record<string, Record<string, string>>
- Defined in mojo.js-main/src/headers.ts:84

remove

remove(name: string): Headers
Remove header.
Parameters
- name: string
Returns Headers
- Defined in mojo.js-main/src/headers.ts:103

set

set(name: string, value: string): Headers
Set header value.
Parameters
- name: string
- value: string
Returns Headers
- Defined in mojo.js-main/src/headers.ts:111

setLinks

setLinks(links: Record<string, string>): Headers
Set web links to Link header according to RFC5988.

Link
http://tools.ietf.org/html/rfc5988

Example
```
// Link to next and previous page
headers.setLinks({next: 'http://example.com/foo', prev: 'http://example.com/bar'});
```
Parameters
- links: Record<string, string>
Returns Headers
- Defined in mojo.js-main/src/headers.ts:124

toArray

toArray(): string[]
Convert headers into a plain array of name/value pairs.

Returns string[]
- Defined in mojo.js-main/src/headers.ts:134

toObject

toObject(): Record<string, string>
Convert headers into a plain object.

Returns Record<string, string>
- Defined in mojo.js-main/src/headers.ts:149

toString

toString(): string
Convert headers to string.

Returns string
- Defined in mojo.js-main/src/headers.ts:160

Generated using TypeDoc