Interface MhtmlHeaders

class for storing headers parse from MHTML

Tries to somewhat mimic the behavior of the fetch-api Headers object, with some differences, notably that it does no validation.

Hierarchy

Iterable<[string, string]>
- MhtmlHeaders

Index

Methods

[iterator] append entries entriesAll get getAll has keys values valuesAll

Methods

[iterator]

[iterator](): Iterator<[string, string], any, undefined>
Returns Iterator<[string, string], any, undefined>
Inherited from Iterable.[iterator]
- Defined in .yarn/cache/typescript-patch-bd21d74a9d-f53bfe97f7.zip/node_modules/typescript/lib/lib.es2015.iterable.d.ts:49

append

append(key, value): void
add a key-value pair

If key is already present it will be appended.
Parameters
- key: string
- value: string
Returns void
- Defined in src/headers.ts:13

entries

entries(delim?): IterableIterator<[string, string]>
iterate over all key-value pairs

Multiple values for the same key will be joined in the order they were added by delim.
Parameters
- Optional delim: string
Returns IterableIterator<[string, string]>
- Defined in src/headers.ts:21

entriesAll

entriesAll(): IterableIterator<[string, string]>
iterate over all key-value pairs

Multiple values for the same key will get iterated in the order they were added.

Returns IterableIterator<[string, string]>
- Defined in src/headers.ts:29

get

get(key, delim?): null | string
get the value for a key

If the key is missing, null will be returned, if multiple values for the key are present, they will be joined be delim.
Parameters
- key: string
- Optional delim: string
Returns null | string
- Defined in src/headers.ts:37

getAll

getAll(key): string[]
get all values for a key
Parameters
- key: string
Returns string[]
- Defined in src/headers.ts:40

has

has(key): boolean
whether key has any values associated with it
Parameters
- key: string
Returns boolean
- Defined in src/headers.ts:43

keys

keys(): Iterable<string>
all keys with at least one value

Returns Iterable<string>
- Defined in src/headers.ts:46

values

values(delim?): IterableIterator<string>
iterate over all values

If a key has multiple values they will be joined by delim.
Parameters
- Optional delim: string
Returns IterableIterator<string>
- Defined in src/headers.ts:53

valuesAll

valuesAll(): IterableIterator<string>
iterate over all values added

Returns IterableIterator<string>
- Defined in src/headers.ts:56

Generated using TypeDoc