High-level Multipart Body Parser

This package, @sensejs/multipart, provides a high-level multipart body parser based on @fastify/busboy that supports custom storage provider and back pressure. It does not depend on any other part of SenseJS, and can be used standalone with any other HTTP framework.

Usage

1
2const [multipart, cleanup] = Multipart.from(req, req.headers);
3
4try {
5  const records = await multipart.read(new MultipartFileDiskStorage());
6} finally {
7  // By default, files stored by `MultipartFileDiskStorage` will be deleted when calling cleanup
8  await cleanup();
9}
10

If your app cannot access disk storage, and you only need to handle small files, you can just call await multipart.read() instead, which will by default to an instance of MultipartFileMemoryStorage that stores files in memory.

If you want to handle large files and persist them on a remote storage, you should implement a custom storage adaptor that derives from RemoteStorageAdaptor, and use it with MultipartFileRemoteStorage.

1
2const [multipart, cleanup] = Multipart.from(req, req.headers);
3
4try {
5  const records = await multipart.read(new MultipartFileRemoteStorage(new YourRemoteStorageAdaptor()));
6} finally {
7  // It will invoke the cleanup method provided by your adaptor
8  await cleanup();
9}