Class Header

constructor

• new Header(...args: HeaderCtor): Header

  Creates a new header.

  Parameters

  • ...args: HeaderCtor

    A field/id with value, optionally prefixed by a charset.

  Returns Header

  Throws

  The field, charset, or value is null, undefined, or invalid.

  Throws

  The header id is not valid.

Readonlyoptions

ReadonlyrawField

offset

Readonlyfield

Readonlyid

ReadonlyisInvalid

onChanged

rawValue

• get rawValue(): Uint8Array

  The raw header value bytes.

  Returns Uint8Array

value

• get value(): string

  The decoded and unfolded header value.

  Returns string

• set value(value: string): void

  Parameters

  • value: string

  Returns void

StaticfromRaw

• fromRaw(
      options: ParserOptions,
      id: string,
      field: string,
      rawValue: Uint8Array,
      invalid?: boolean,
      rawField?: Uint8Array<ArrayBufferLike>,
  ): Header

  Creates a header from raw field and value bytes.

  Parameters

  • options: ParserOptions

    The parser options.

  • id: string

    The header identifier.

  • field: string

    The header field name.

  • rawValue: Uint8Array

    The raw header value bytes.

  • invalid: boolean = false

    Whether the header is syntactically invalid.

  • OptionalrawField: Uint8Array<ArrayBufferLike>

    The raw field bytes.

  Returns Header

  The created header.

clone

• clone(): Header

  Clones this header.

  Returns Header

  The cloned header.

getValue

• getValue(charset: string | CharsetEncoding): string

  Gets the decoded header value using the specified charset.

  Parameters

  • charset: string | CharsetEncoding

    The charset to use for decoding.

  Returns string

  The decoded and unfolded header value.

  Throws

  charset is null or undefined.

setValue

• setValue(
      format: FormatOptions,
      charset: string | CharsetEncoding,
      value: string,
  ): void

  Sets the header value using the specified formatting options and charset.

  Parameters

  • format: FormatOptions

    The formatting options.

  • charset: string | CharsetEncoding

    The charset to use for encoding.

  • value: string

    The header value.

  Returns void

  Throws

  format, charset, or value is null or undefined.

• setValue(charset: string | CharsetEncoding, value: string): void

  Sets the header value using the specified charset.

  Parameters

  • charset: string | CharsetEncoding

    The charset to use for encoding.

  • value: string

    The header value.

  Returns void

  Throws

  charset or value is null or undefined.

setRawValue

• setRawValue(value: Uint8Array): void

  Sets the raw header value bytes.

  Parameters

  • value: Uint8Array

    The raw value bytes, including a trailing newline.

  Returns void

  Throws

  value is null, undefined, or does not end with a newline.

getRawValue

• getRawValue(format: FormatOptions): Uint8Array

  Gets the raw header value bytes for the specified formatting options.

  Parameters

  • format: FormatOptions

    The formatting options.

  Returns Uint8Array

  The raw header value bytes.

toString

• toString(): string

  Serializes this header.

  Returns string

  A string representing this header.

Staticunfold

• unfold(text: string | null | undefined): string

  Unfolds a header value by removing line breaks.

  Parameters

  • text: string | null | undefined

    The header value text.

  Returns string

  The unfolded header value.

Staticfold

• fold(format: FormatOptions, field: string, value: string): string

  Folds a header value according to the specified formatting options.

  Parameters

  • format: FormatOptions

    The formatting options.

  • field: string

    The header field name.

  • value: string

    The header value.

  Returns string

  The folded header value.

StaticreformatAddressHeader

• reformatAddressHeader(
      options: ParserOptions,
      format: FormatOptions,
      field: string,
      rawValue: Uint8Array,
  ): Uint8Array

  Reformats an address header value for the specified formatting options.

  Parameters

  • options: ParserOptions

    The parser options.

  • format: FormatOptions

    The formatting options.

  • field: string

    The header field name.

  • rawValue: Uint8Array

    The raw header value bytes.

  Returns Uint8Array

  The reformatted raw value bytes, or the original bytes if parsing fails.

Staticparse

• parse(
      input: string | Uint8Array<ArrayBufferLike>,
      options?: ParserOptions,
      startIndex?: number,
      length?: number,
  ): Result<Header>

  Parses a header from text or bytes.

  Parameters

  • input: string | Uint8Array<ArrayBufferLike>

    The input to parse.

  • options: ParserOptions = ParserOptions.default

    The parser options.

  • startIndex: number = 0

    The starting index of the input.

  • Optionallength: number

    The number of bytes to parse.

  Returns Result<Header>

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

  Throws

  input is null or undefined.

  Throws

  startIndex or length is out of range.