Class HeaderList

constructor

• new HeaderList(options?: ParserOptions): HeaderList

  Creates a new header list.

  Parameters

  • options: ParserOptions = ...

    The parser options associated with headers in the list.

  Returns HeaderList

  Throws

  options is null or undefined.

Readonlyoptions

onChanged

hasBodySeparator

count

• get count(): number

  The number of headers.

  Returns number

isReadOnly

• get isReadOnly(): boolean

  Whether this list is read-only.

  Returns boolean

at

• at(index: number): Header

  Gets the header at the specified index.

  Parameters

  • index: number

    The index.

  Returns Header

  The header.

  Throws

  index is out of range.

set

• set(index: number, value: Header): void

  Replaces the header at the specified index.

  Parameters

  • index: number

    The index.

  • value: Header

    The replacement header.

  Returns void

  Throws

  value is null or undefined.

  Throws

  index is out of range.

getValue

• getValue(idOrField: string): string | null

  Gets the value of the first matching header.

  Parameters

  • idOrField: string

    The header identifier or field name.

  Returns string | null

  The header value, or null if it does not exist.

setValue

• setValue(idOrField: string, value: string): void

  Sets the value of the first matching header, adding it if it does not exist.

  Parameters

  • idOrField: string

    The header identifier or field name.

  • value: string

    The header value.

  Returns void

  Throws

  value is null or undefined.

add

• add(...args: HeaderListAddArgs): void

  Adds a header to the list.

  Parameters

  • ...args: HeaderListAddArgs

    A header instance, or a field/id with value and optional charset.

  Returns void

clear

• clear(): void

  Removes all headers from the list.

  Returns void

contains

• contains(value: string | Header): boolean

  Determines whether the list contains the specified header or field.

  Parameters

  • value: string | Header

    The header, header identifier, or field name.

  Returns boolean

  true if the header is contained; otherwise, false.

  Throws

  value is null or undefined.

copyTo

• copyTo(array: Header[], arrayIndex: number): void

  Copies the headers to an array.

  Parameters

  • array: Header[]

    The destination array.

  • arrayIndex: number

    The index into the array.

  Returns void

  Throws

  array is null or undefined.

  Throws

  arrayIndex is out of range or the array is too small.

indexOf

• indexOf(value: string | Header): number

  Gets the index of the first matching header.

  Parameters

  • value: string | Header

    The header, header identifier, or field name.

  Returns number

  The header index, or -1 if it is not found.

  Throws

  value is null or undefined.

insert

• insert(...args: HeaderListInsertArgs): void

  Inserts a header at the specified index.

  Parameters

  • ...args: HeaderListInsertArgs

    The index and a header instance, or a field/id with value and optional charset.

  Returns void

  Throws

  The index is out of range.

lastIndexOf

• lastIndexOf(value: string): number

  Gets the index of the last matching header.

  Parameters

  • value: string

    The header identifier or field name.

  Returns number

  The header index, or -1 if it is not found.

  Throws

  value is null or undefined.

remove

• remove(value: string | Header): boolean

  Removes the first matching header.

  Parameters

  • value: string | Header

    The header, header identifier, or field name.

  Returns boolean

  true if a header was removed; otherwise, false.

  Throws

  value is null or undefined.

removeAll

• removeAll(value: string): void

  Removes all headers matching the specified field.

  Parameters

  • value: string

    The header identifier or field name.

  Returns void

  Throws

  value is null or undefined.

removeAt

• removeAt(index: number): void

  Removes the header at the specified index.

  Parameters

  • index: number

    The index.

  Returns void

  Throws

  index is out of range.

replace

• replace(...args: HeaderListAddArgs): void

  Replaces all matching headers with a single header.

  Parameters

  • ...args: HeaderListAddArgs

    A header instance, or a field/id with value and optional charset.

  Returns void

tryGetHeader

• tryGetHeader(value: string): Header | null

  Attempts to get the first matching header.

  Parameters

  • value: string

    The header identifier or field name.

  Returns Header | null

  The header, or null if it does not exist.

writeTo

• writeTo(stream: Stream): void

  Writes the headers to a stream.

  Parameters

  • stream: Stream

    The output stream.

  Returns void

  Throws

  stream is null or undefined.

• writeTo(options: FormatOptions, stream: Stream): void

  Writes the headers to a stream using the specified formatting options.

  Parameters

  • options: FormatOptions

    The formatting options.

  • stream: Stream

    The output stream.

  Returns void

  Throws

  options or stream is null or undefined.

[iterator]

• "[iterator]"(): Iterator<Header>

  Returns Iterator<Header>

Staticload

• load(
      source: Uint8Array<ArrayBufferLike> | Stream,
      options?: ParserOptions,
  ): Result<HeaderList>

  Parses a list of headers from a stream or byte buffer.

  Parameters

  • source: Uint8Array<ArrayBufferLike> | Stream

    The source stream or buffer.

  • options: ParserOptions = ParserOptions.default

    The parser options.

  Returns Result<HeaderList>

  A Result; { ok: false } with a MimeError on malformed input.

  Throws

  source is null or undefined.