Class ContentDisposition

constructor

• new ContentDisposition(disposition?: string): ContentDisposition

  Creates a new content disposition.

  Parameters

  • disposition: string = ContentDisposition.attachment

    The disposition token.

  Returns ContentDisposition

  Throws

  disposition is null, undefined, or invalid.

Static Readonlyattachment

Static ReadonlyformData

Static Readonlyinline

parameters

onChanged

disposition

• get disposition(): string

  The disposition token.

  Returns string

• set disposition(value: string): void

  Parameters

  • value: string

  Returns void

isAttachment

• get isAttachment(): boolean

  Whether this disposition represents an attachment.

  Returns boolean

• set isAttachment(value: boolean): void

  Parameters

  • value: boolean

  Returns void

fileName

• get fileName(): string | null

  The file name parameter, if available.

  Returns string | null

• set fileName(value: string | null): void

  Parameters

  • value: string | null

  Returns void

creationDate

• get creationDate(): DateTimeOffset | null

  The creation date parameter, if available.

  Returns DateTimeOffset | null

• set creationDate(value: DateTimeOffset | null): void

  Parameters

  • value: DateTimeOffset | null

  Returns void

modificationDate

• get modificationDate(): DateTimeOffset | null

  The modification date parameter, if available.

  Returns DateTimeOffset | null

• set modificationDate(value: DateTimeOffset | null): void

  Parameters

  • value: DateTimeOffset | null

  Returns void

readDate

• get readDate(): DateTimeOffset | null

  The read date parameter, if available.

  Returns DateTimeOffset | null

• set readDate(value: DateTimeOffset | null): void

  Parameters

  • value: DateTimeOffset | null

  Returns void

size

• get size(): number | null

  The size parameter, if available.

  Returns number | null

• set size(value: number | null): void

  Parameters

  • value: number | null

  Returns void

clone

• clone(): ContentDisposition

  Clones this content disposition.

  Returns ContentDisposition

  The cloned content disposition.

encode

• encode(options?: FormatOptions, charset?: CharsetEncoding): string

  Encodes this content disposition as a folded header value.

  Parameters

  • options: FormatOptions = FormatOptions.default

    The formatting options.

  • charset: CharsetEncoding = utf8

    The charset to use when encoding parameter values.

  Returns string

  The serialized header value.

toString

• toString(
      options?: FormatOptions,
      charset?: CharsetEncoding,
      encode?: boolean,
  ): string

  Serializes this content disposition.

  Parameters

  • options: FormatOptions = FormatOptions.default

    The formatting options.

  • charset: CharsetEncoding = utf8

    The charset to use when encoding parameter values.

  • encode: boolean = false

    If true, parameter values will be encoded.

  Returns string

  The serialized string.

Staticparse

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

  Parses a content disposition from text or bytes.

  Parameters

  • input: string | Uint8Array<ArrayBufferLike>

    The input to parse.

  • options: ParserOptions = ParserOptions.default

    The parser options.

  Returns Result<ContentDisposition>

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

  Throws

  input is null or undefined.

StatictryParse

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

  Attempts to parse a content disposition 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<ContentDisposition>

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