Class ParameterList

constructor

• new ParameterList(): ParameterList

  Returns ParameterList

onChanged

onBoundaryChanged

count

• get count(): number

  The number of parameters in the list.

  Returns number

isReadOnly

• get isReadOnly(): boolean

  C#: IList.IsReadOnly (always false).

  Returns boolean

length

• get length(): number

  The number of parameters in the list.

  Returns number

Staticparse

• parse(
      input: string | Uint8Array<ArrayBufferLike>,
      options?: ParserOptions,
  ): Result<ParameterList>

  Parses a parameter list from text or bytes.

  Parameters

  • input: string | Uint8Array<ArrayBufferLike>

    The input to parse.

  • options: ParserOptions = ParserOptions.default

    The parser options.

  Returns Result<ParameterList>

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

StatictryParse

• tryParse(
      options: ParserOptions,
      text: Uint8Array,
      cursor: ParseCursor,
      endIndex: number,
  ): Result<ParameterList>

  Attempts to parse a parameter list from a byte range.

  Parameters

  • options: ParserOptions

    The parser options.

  • text: Uint8Array

    The input buffer.

  • cursor: ParseCursor

    The current parse cursor.

  • endIndex: number

    The end index of the input range.

  Returns Result<ParameterList>

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

add

• add(parameter: Parameter): void

  Adds a parameter to the list.

  Parameters

  • parameter: Parameter

    The parameter to add.

  Returns void

  Throws

  A parameter with the same name already exists.

• add(name: string, value: string): void

  Adds a parameter with the specified name and value.

  Parameters

  • name: string

    The parameter name.

  • value: string

    The parameter value.

  Returns void

• add(charset: string | CharsetEncoding, name: string, value: string): void

  Adds a parameter with the specified charset, name, and value.

  Parameters

  • charset: string | CharsetEncoding

    The charset to use when encoding the value.

  • name: string

    The parameter name.

  • value: string

    The parameter value.

  Returns void

clear

• clear(): void

  Removes all parameters from the list.

  Returns void

contains

• contains(nameOrParameter: string | Parameter): boolean

  Determines whether the list contains the specified parameter or parameter name.

  Parameters

  • nameOrParameter: string | Parameter

    The parameter or parameter name.

  Returns boolean

  true if the parameter is contained; otherwise, false.

  Throws

  nameOrParameter is null or undefined.

indexOf

• indexOf(nameOrParameter: string | Parameter): number

  Gets the index of the specified parameter or parameter name.

  Parameters

  • nameOrParameter: string | Parameter

    The parameter or parameter name.

  Returns number

  The index of the parameter, or -1 if it is not found.

  Throws

  nameOrParameter is null or undefined.

insert

• insert(index: number, parameter: Parameter): void

  Inserts a parameter at the specified index.

  Parameters

  • index: number

    The insertion index.

  • parameter: Parameter

    The parameter to insert.

  Returns void

  Throws

  index is out of range.

  Throws

  A parameter with the same name already exists.

• insert(index: number, name: string, value: string): void

  Inserts a parameter with the specified name and value.

  Parameters

  • index: number

    The insertion index.

  • name: string

    The parameter name.

  • value: string

    The parameter value.

  Returns void

remove

• remove(nameOrParameter: string | Parameter): boolean

  Removes a parameter from the list.

  Parameters

  • nameOrParameter: string | Parameter

    The parameter or parameter name to remove.

  Returns boolean

  true if the parameter was removed; otherwise, false.

  Throws

  nameOrParameter is null or undefined.

removeAt

• removeAt(index: number): void

  Removes the parameter at the specified index.

  Parameters

  • index: number

    The index to remove.

  Returns void

  Throws

  index is out of range.

get

• get(index: number): Parameter

  Gets the parameter at the specified index.

  Parameters

  • index: number

    The parameter index.

  Returns Parameter

• get(name: string): string | null

  Gets the value of the specified parameter name.

  Parameters

  • name: string

    The parameter name.

  Returns string | null

  The parameter value, or null if it is not found.

set

• set(index: number, parameter: Parameter): void

  Replaces the parameter at the specified index.

  Parameters

  • index: number

    The parameter index.

  • parameter: Parameter

    The replacement parameter.

  Returns void

  Throws

  index is out of range.

• set(name: string, value: string): void

  Sets a parameter value by name, adding it if it does not exist.

  Parameters

  • name: string

    The parameter name.

  • value: string

    The parameter value.

  Returns void

tryGetValue

• tryGetValue(name: string): Parameter | null

  Attempts to get a parameter by name.

  Parameters

  • name: string

    The parameter name.

  Returns Parameter | null

  The parameter, or null if it is not found.

  Throws

  name is null or undefined.

[iterator]

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

  Returns Iterator<Parameter>

encode

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

  Encodes the parameter list 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.

  • charset: CharsetEncoding = utf8

    The charset to use when encoding parameter values.

  Returns void

writeTo

• writeTo(builder: string[]): void

  Writes the parameter list without applying header encoding.

  Parameters

  • builder: string[]

    The destination string fragments.

  Returns void

toString

• toString(): string

  Serializes the parameter list.

  Returns string

  A string representing the parameter list.