Class Multipart

constructor

• new Multipart(
      parts: Part[],
      boundary?: string | Uint8Array<ArrayBufferLike>,
      mediaType?: string,
  ): Multipart

  Create a new Multipart instance

  Parameters

  • parts: Part[]

    The parts to include in the multipart

  • Optionalboundary: string | Uint8Array<ArrayBufferLike> = ...

    The multipart boundary used to separate the parts. Randomly generated if not provided

  • OptionalmediaType: string = "multipart/mixed"

    The media type of the multipart. Defaults to "multipart/mixed"

  Returns Multipart

Readonlyheaders

Readonlyparts

body

• get body(): Uint8Array

  Get the bytes of the body of this multipart. Includes all parts separated by the boundary. Does not include the headers.

  Returns Uint8Array

  Throws

  RangeError If the multipart boundary is invalid. A valid boundary is 1 to 70 characters long, does not end with space, and may only contain: A-Z a-z 0-9 '()+_,-./:=? and space

boundary

• get boundary(): Uint8Array

  Get the boundary bytes used to separate the parts

  Returns Uint8Array

• set boundary(boundary: string | Uint8Array<ArrayBufferLike>): void

  Set the boundary bytes used to separate the parts

  Parameters

  • boundary: string | Uint8Array<ArrayBufferLike>

  Returns void

mediaType

• get mediaType(): string

  The media type of the multipart

  Returns string

  Example

  "multipart/mixed"
  Copy

  Example

  "multipart/form-data"
  Copy

  Example

  "multipart/byteranges"
  Copy

• set mediaType(mediaType: string): void

  Parameters

  • mediaType: string

  Returns void

blob

• blob(): Blob

  Create Blob from this multipart.

  Returns Blob

  Throws

  RangeError If the multipart boundary is invalid. A valid boundary is 1 to 70 characters long, does not end with space, and may only contain: A-Z a-z 0-9 '()+_,-./:=? and space.

bytes

• bytes(): Uint8Array

  Get the bytes of the headers and body of this multipart.

  Returns Uint8Array

  Throws

  RangeError If the multipart boundary is invalid. A valid boundary is 1 to 70 characters long, does not end with space, and may only contain: A-Z a-z 0-9 '()+_,-./:=? and space

formData

• formData(): FormData

  Create FormData from this multipart. Only parts that have Content-Disposition set to form-data and a non-empty name will be included.

  Returns FormData

Staticblob

• blob(blob: Blob): Promise<Multipart>

  Create Multipart from a Blob. The boundary and media type are determined from the blob's type.

  Parameters

  • blob: Blob

    The blob

  Returns Promise<Multipart>

  Throws

  SyntaxError If the Content-Type header is missing or does not include a boundary

StaticformData

• formData(
      formData: FormData,
      boundary?: string | Uint8Array<ArrayBufferLike>,
  ): Promise<Multipart>

  Create Multipart from FormData. This method might be slow if the form data contains large files.

  Parameters

  • formData: FormData

    Form data

  • Optionalboundary: string | Uint8Array<ArrayBufferLike>

    Multipart boundary to use to separate the parts. If not provided, a random boundary will be generated.

  Returns Promise<Multipart>

Staticparse

• parse(data: Uint8Array): Multipart

  Parse multipart bytes (including headers). The boundary and media type are determined from the headers.

  Parameters

  • data: Uint8Array

    Byte representation of the multipart headers and body

  Returns Multipart

  Throws

  SyntaxError If the Content-Type header is missing or does not include a boundary

StaticparseBody

• parseBody(data: Uint8Array, boundary: Uint8Array, mediaType?: string): Multipart

  Parse multipart body data

  Parameters

  • data: Uint8Array

    Multipart body bytes

  • boundary: Uint8Array

    The multipart boundary bytes used in the body bytes to separate the parts

  • OptionalmediaType: string

    Multipart media type to pass to the constructor

  Returns Multipart

Staticpart

• part(part: Part): Multipart

  Create Multipart from a Part. The boundary and media type are determined from the part's headers.

  Parameters

  • part: Part

    The part

  Returns Multipart

  Throws

  SyntaxError If the Content-Type header is missing or does not include a boundary