Class Multipart

constructor

• new Multipart(
      ctx: HttpContext,
      config?: Partial<
          {
              limit: string
              | number;
              fieldsLimit: string | number;
              maxFields: number;
              convertEmptyStringsToNull: boolean;
          },
      >,
      _featureFlags?: Record<string, never>,
  ): Multipart

  Creates a new Multipart instance for processing multipart form data

  Parameters

  • ctx: HttpContext

    The HTTP context

  • config: Partial<
        {
            limit: string
            | number;
            fieldsLimit: string | number;
            maxFields: number;
            convertEmptyStringsToNull: boolean;
        },
    > = {}

    Configuration options for multipart processing

  • _featureFlags: Record<string, never> = {}

    Feature flags (unused)

  Returns Multipart

state

onFile

• onFile(
      name: string,
      options: Partial<FileValidationOptions & { deferValidations: boolean }>,
      handler: PartHandler,
  ): this

  Attach handler for a given file. To handle all files, you can attach a wildcard handler.

  Parameters

  • name: string

    The field name to handle, or '*' for wildcard

  • options: Partial<FileValidationOptions & { deferValidations: boolean }>

    Validation options and configuration

  • handler: PartHandler

    The handler function to process the file

  Returns this

  Example

  multipart.onFile('package', {}, async (stream) => {
  })
  
  multipart.onFile('*', {}, async (stream) => {
  })
  Copy

abort

• abort(error: any): void

  Abort request by emitting error

  Parameters

  • error: any

    The error that caused the abort

  Returns void

process

• process(
      config?: Partial<{ limit: string | number; maxFields: number }>,
  ): Promise<void>

  Process the request by going through all the file and field streams.

  Parameters

  • Optionalconfig: Partial<{ limit: string | number; maxFields: number }>

    Optional configuration overrides

  Returns Promise<void>