Class ContentType

constructor

• new ContentType(mediaType: string, mediaSubtype: string): ContentType

  Creates a new content type with the specified media type and subtype.

  Parameters

  • mediaType: string

    The media type.

  • mediaSubtype: string

    The media subtype.

  Returns ContentType

  Throws

  mediaType or mediaSubtype is null or undefined.

parameters

onChanged

mediaType

• get mediaType(): string

  The media type.

  Returns string

• set mediaType(value: string): void

  Parameters

  • value: string

  Returns void

mediaSubtype

• get mediaSubtype(): string

  The media subtype.

  Returns string

• set mediaSubtype(value: string): void

  Parameters

  • value: string

  Returns void

boundary

• get boundary(): string | null

  The boundary parameter, if available.

  Returns string | null

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

  Parameters

  • value: string | null

  Returns void

charset

• get charset(): string | null

  The charset parameter, if available.

  Returns string | null

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

  Parameters

  • value: string | null

  Returns void

charsetEncoding

• get charsetEncoding(): CharsetEncoding | null

  The charset encoding represented by the charset parameter, if available.

  Returns CharsetEncoding | null

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

  Parameters

  • value: CharsetEncoding | null

  Returns void

format

• get format(): string | null

  The format parameter, if available.

  Returns string | null

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

  Parameters

  • value: string | null

  Returns void

mimeType

• get mimeType(): string

  The MIME type in type/subtype form.

  Returns string

name

• get name(): string | null

  The name parameter, if available.

  Returns string | null

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

  Parameters

  • value: string | null

  Returns void

clone

• clone(): ContentType

  Clones this content type.

  Returns ContentType

  The cloned content type.

isMimeType

• isMimeType(mediaType: string, mediaSubtype: string): boolean

  Determines whether this content type matches the specified media type and subtype.

  The * wildcard may be used for either argument.

  Parameters

  • mediaType: string

    The media type.

  • mediaSubtype: string

    The media subtype.

  Returns boolean

  true if this content type matches; otherwise, false.

  Throws

  mediaType or mediaSubtype is null or undefined.

encode

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

  Encodes this content type 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 type.

  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<ContentType>

  Parses a content type from text or bytes.

  Parameters

  • input: string | Uint8Array<ArrayBufferLike>

    The input to parse.

  • options: ParserOptions = ParserOptions.default

    The parser options.

  Returns Result<ContentType>

  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,
      partial?: { contentType: ContentType | null },
  ): Result<ContentType>

  Attempts to parse a content type 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.

  • Optionalpartial: { contentType: ContentType | null }

    Receives a partially parsed content type when type/subtype parsing succeeds.

  Returns Result<ContentType>

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