Class Parameter

constructor

• new Parameter(name: string, value: string): Parameter

  Creates a new MIME parameter.

  Parameters

  • name: string

    The parameter name.

  • value: string

    The parameter value.

  Returns Parameter

  Throws

  name or value is null, undefined, empty, or invalid.

• new Parameter(
      charset: string | CharsetEncoding,
      name: string,
      value: string,
  ): Parameter

  Creates a new MIME parameter using the specified charset for encoded values.

  Parameters

  • charset: string | CharsetEncoding

    The charset to use when encoding the value.

  • name: string

    The parameter name.

  • value: string

    The parameter value.

  Returns Parameter

  Throws

  charset, name, or value is null, undefined, or invalid.

Readonlyname

onChanged

encoding

• get encoding(): CharsetEncoding

  The charset used when encoding this parameter value.

  Returns CharsetEncoding

• set encoding(value: CharsetEncoding | null): void

  Parameters

  • value: CharsetEncoding | null

  Returns void

encodingMethod

• get encodingMethod(): ParameterEncodingMethod

  The encoding method used when serializing this parameter.

  Returns ParameterEncodingMethod

• set encodingMethod(value: ParameterEncodingMethod): void

  Parameters

  • value: ParameterEncodingMethod

  Returns void

alwaysQuote

• get alwaysQuote(): boolean

  Whether the parameter value should always be quoted.

  Returns boolean

• set alwaysQuote(value: boolean): void

  Parameters

  • value: boolean

  Returns void

value

• get value(): string

  The parameter value.

  Returns string

• set value(value: string): void

  Parameters

  • value: string

  Returns void

clone

• clone(): Parameter

  Clones this parameter.

  Returns Parameter

  The cloned parameter.

encode

• encode(
      options: FormatOptions,
      builder: string[],
      lineLength: { value: number },
      headerEncoding?: CharsetEncoding,
  ): void

  Encodes this parameter and appends it to a string builder.

  Parameters

  • options: FormatOptions

    The formatting options.

  • builder: string[]

    The destination string fragments.

  • lineLength: { value: number }

    The current output line length.

  • headerEncoding: CharsetEncoding = utf8

    The charset to use for encoded parameter values.

  Returns void

writeTo

• writeTo(builder: string[]): void

  Writes this parameter without applying header encoding.

  Parameters

  • builder: string[]

    The destination string fragments.

  Returns void

toString

• toString(): string

  Serializes this parameter.

  Returns string

  A string representing this parameter.