wiki-plugin-allyabase 0.0.2 → 0.0.4

package/test/node_modules/formidable/README.md

@@ -1,884 +0,0 @@
-<p align="center">
-  <img alt="npm formidable package logo" src="https://raw.githubusercontent.com/node-formidable/formidable/master/logo.png" />
-</p>
-
-# formidable [![npm version][npmv-img]][npmv-url] [![MIT license][license-img]][license-url] [![Libera Manifesto][libera-manifesto-img]][libera-manifesto-url] [![Twitter][twitter-img]][twitter-url]
-
-> A Node.js module for parsing form data, especially file uploads.
-
-[![Code style][codestyle-img]][codestyle-url]
-[![codecoverage][codecov-img]][codecov-url]
-[![linux build status][linux-build-img]][build-url]
-[![windows build status][windows-build-img]][build-url]
-[![macos build status][macos-build-img]][build-url]
-
-If you have any _how-to_ kind of questions, please read the [Contributing
-Guide][contributing-url] and [Code of Conduct][code_of_conduct-url]
-documents.<br /> For bugs reports and feature requests, [please create an
-issue][open-issue-url] or ping [@tunnckoCore / @3a1FcBx0](https://twitter.com/3a1FcBx0)
-at Twitter.
-
-[![Conventional Commits][ccommits-img]][ccommits-url]
-[![Minimum Required Nodejs][nodejs-img]][npmv-url]
-[![Tidelift Subscription][tidelift-img]][tidelift-url]
-[![Buy me a Kofi][kofi-img]][kofi-url]
-[![Renovate App Status][renovateapp-img]][renovateapp-url]
-[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]
-
-This project is [semantically versioned](https://semver.org) and available as
-part of the [Tidelift Subscription][tidelift-url] for professional grade
-assurances, enhanced support and security.
-[Learn more.](https://tidelift.com/subscription/pkg/npm-formidable?utm_source=npm-formidable&utm_medium=referral&utm_campaign=enterprise)
-
-_The maintainers of `formidable` and thousands of other packages are working
-with Tidelift to deliver commercial support and maintenance for the Open Source
-dependencies you use to build your applications. Save time, reduce risk, and
-improve code health, while paying the maintainers of the exact dependencies you
-use._
-
-[![][npm-weekly-img]][npmv-url] [![][npm-monthly-img]][npmv-url]
-[![][npm-yearly-img]][npmv-url] [![][npm-alltime-img]][npmv-url]
-
-## Project Status: Maintained
-
-_Check [VERSION NOTES](https://github.com/node-formidable/formidable/blob/master/VERSION_NOTES.md) for more information on v1, v2, and v3 plans, NPM dist-tags and branches._
-
-This module was initially developed by
-[**@felixge**](https://github.com/felixge) for
-[Transloadit](http://transloadit.com/), a service focused on uploading and
-encoding images and videos. It has been battle-tested against hundreds of GBs of
-file uploads from a large variety of clients and is considered production-ready
-and is used in production for years.
-
-Currently, we are few maintainers trying to deal with it. :) More contributors
-are always welcome! :heart: Jump on
-[issue #412](https://github.com/felixge/node-formidable/issues/412) which is
-closed, but if you are interested we can discuss it and add you after strict
-rules, like enabling Two-Factor Auth in your npm and GitHub accounts.
-
-## Highlights
-
-- [Fast (~900-2500 mb/sec)](#benchmarks) & streaming multipart parser
-- Automatically writing file uploads to disk (optional, see
-  [`options.fileWriteStreamHandler`](#options))
-- [Plugins API](#useplugin-plugin) - allowing custom parsers and plugins
-- Low memory footprint
-- Graceful error handling
-- Very high test coverage
-
-## Install
-
-This package is a dual ESM/commonjs package.
-
-This project requires `Node.js >= 10.13`. Install it using
-[yarn](https://yarnpkg.com) or [npm](https://npmjs.com).<br /> _We highly
-recommend to use Yarn when you think to contribute to this project._
-
-This is a low-level package, and if you're using a high-level framework it _may_
-already be included. Check the examples below and the [examples/](https://github.com/node-formidable/formidable/tree/master/examples) folder.
-
-```
-# v2
-npm install formidable@v2
-
-# v3
-npm install formidable
-npm install formidable@v3
-```
-
-_**Note:** Future not ready releases will be published on `*-next` dist-tags for the corresponding version._
-
-
-## Examples
-
-For more examples look at the `examples/` directory.
-
-### with Node.js http module
-
-Parse an incoming file upload, with the
-[Node.js's built-in `http` module](https://nodejs.org/api/http.html).
-
-```js
-import http from 'node:http';
-import formidable, {errors as formidableErrors} from 'formidable';
-
-const server = http.createServer(async (req, res) => {
-  if (req.url === '/api/upload' && req.method.toLowerCase() === 'post') {
-    // parse a file upload
-    const form = formidable({});
-    let fields;
-    let files;
-    try {
-        [fields, files] = await form.parse(req);
-    } catch (err) {
-        // example to check for a very specific error
-        if (err.code === formidableErrors.maxFieldsExceeded) {
-
-        }
-        console.error(err);
-        res.writeHead(err.httpCode || 400, { 'Content-Type': 'text/plain' });
-        res.end(String(err));
-        return;
-    }
-    res.writeHead(200, { 'Content-Type': 'application/json' });
-    res.end(JSON.stringify({ fields, files }, null, 2));
-    return;
-  }
-
-  // show a file upload form
-  res.writeHead(200, { 'Content-Type': 'text/html' });
-  res.end(`
-    <h2>With Node.js <code>"http"</code> module</h2>
-    <form action="/api/upload" enctype="multipart/form-data" method="post">
-      <div>Text field title: <input type="text" name="title" /></div>
-      <div>File: <input type="file" name="multipleFiles" multiple="multiple" /></div>
-      <input type="submit" value="Upload" />
-    </form>
-  `);
-});
-
-server.listen(8080, () => {
-  console.log('Server listening on http://localhost:8080/ ...');
-});
-```
-
-### with Express.js
-
-There are multiple variants to do this, but Formidable just need Node.js Request
-stream, so something like the following example should work just fine, without
-any third-party [Express.js](https://ghub.now.sh/express) middleware.
-
-Or try the
-[examples/with-express.js](https://github.com/node-formidable/formidable/blob/master/examples/with-express.js)
-
-```js
-import express from 'express';
-import formidable from 'formidable';
-
-const app = express();
-
-app.get('/', (req, res) => {
-  res.send(`
-    <h2>With <code>"express"</code> npm package</h2>
-    <form action="/api/upload" enctype="multipart/form-data" method="post">
-      <div>Text field title: <input type="text" name="title" /></div>
-      <div>File: <input type="file" name="someExpressFiles" multiple="multiple" /></div>
-      <input type="submit" value="Upload" />
-    </form>
-  `);
-});
-
-app.post('/api/upload', (req, res, next) => {
-  const form = formidable({});
-
-  form.parse(req, (err, fields, files) => {
-    if (err) {
-      next(err);
-      return;
-    }
-    res.json({ fields, files });
-  });
-});
-
-app.listen(3000, () => {
-  console.log('Server listening on http://localhost:3000 ...');
-});
-```
-
-### with Koa and Formidable
-
-Of course, with [Koa v1, v2 or future v3](https://ghub.now.sh/koa) the things
-are very similar. You can use `formidable` manually as shown below or through
-the [koa-better-body](https://ghub.now.sh/koa-better-body) package which is
-using `formidable` under the hood and support more features and different
-request bodies, check its documentation for more info.
-
-_Note: this example is assuming Koa v2. Be aware that you should pass `ctx.req`
-which is Node.js's Request, and **NOT** the `ctx.request` which is Koa's Request
-object - there is a difference._
-
-```js
-import Koa from 'Koa';
-import formidable from 'formidable';
-
-const app = new Koa();
-
-app.on('error', (err) => {
-  console.error('server error', err);
-});
-
-app.use(async (ctx, next) => {
-  if (ctx.url === '/api/upload' && ctx.method.toLowerCase() === 'post') {
-    const form = formidable({});
-
-    // not very elegant, but that's for now if you don't want to use `koa-better-body`
-    // or other middlewares.
-    await new Promise((resolve, reject) => {
-      form.parse(ctx.req, (err, fields, files) => {
-        if (err) {
-          reject(err);
-          return;
-        }
-
-        ctx.set('Content-Type', 'application/json');
-        ctx.status = 200;
-        ctx.state = { fields, files };
-        ctx.body = JSON.stringify(ctx.state, null, 2);
-        resolve();
-      });
-    });
-    await next();
-    return;
-  }
-
-  // show a file upload form
-  ctx.set('Content-Type', 'text/html');
-  ctx.status = 200;
-  ctx.body = `
-    <h2>With <code>"koa"</code> npm package</h2>
-    <form action="/api/upload" enctype="multipart/form-data" method="post">
-    <div>Text field title: <input type="text" name="title" /></div>
-    <div>File: <input type="file" name="koaFiles" multiple="multiple" /></div>
-    <input type="submit" value="Upload" />
-    </form>
-  `;
-});
-
-app.use((ctx) => {
-  console.log('The next middleware is called');
-  console.log('Results:', ctx.state);
-});
-
-app.listen(3000, () => {
-  console.log('Server listening on http://localhost:3000 ...');
-});
-```
-
-## Benchmarks
-
-The benchmark is quite old, from the old codebase. But maybe quite true though.
-Previously the numbers was around ~500 mb/sec. Currently with moving to the new
-Node.js Streams API it's faster. You can clearly see the differences between the
-Node versions.
-
-_Note: a lot better benchmarking could and should be done in future._
-
-Benchmarked on 8GB RAM, Xeon X3440 (2.53 GHz, 4 cores, 8 threads)
-
-```
-~/github/node-formidable master
-❯ nve --parallel 8 10 12 13 node benchmark/bench-multipart-parser.js
-
- ⬢  Node 8
-
-1261.08 mb/sec
-
- ⬢  Node 10
-
-1113.04 mb/sec
-
- ⬢  Node 12
-
-2107.00 mb/sec
-
- ⬢  Node 13
-
-2566.42 mb/sec
-```
-
-![benchmark January 29th, 2020](./benchmark/2020-01-29_xeon-x3440.png)
-
-## API
-
-### Formidable / IncomingForm
-
-All shown are equivalent.
-
-_Please pass [`options`](#options) to the function/constructor, not by assigning
-them to the instance `form`_
-
-```js
-import formidable from 'formidable';
-const form = formidable(options);
-```
-
-### Options
-
-See it's defaults in [src/Formidable.js DEFAULT_OPTIONS](./src/Formidable.js)
-(the `DEFAULT_OPTIONS` constant).
-
-- `options.encoding` **{string}** - default `'utf-8'`; sets encoding for
-  incoming form fields,
-- `options.uploadDir` **{string}** - default `os.tmpdir()`; the directory for
-  placing file uploads in. You can move them later by using `fs.rename()`.
-- `options.keepExtensions` **{boolean}** - default `false`; to include the
-  extensions of the original files or not
-- `options.allowEmptyFiles` **{boolean}** - default `false`; allow upload empty
-  files
-- `options.minFileSize` **{number}** - default `1` (1byte); the minium size of
-  uploaded file.
-- `options.maxFiles` **{number}** - default `Infinity`;
-  limit the amount of uploaded files, set Infinity for unlimited
-- `options.maxFileSize` **{number}** - default `200 * 1024 * 1024` (200mb);
-  limit the size of each uploaded file.
-- `options.maxTotalFileSize` **{number}** - default `options.maxFileSize`;
-  limit the size of the batch of uploaded files.
-- `options.maxFields` **{number}** - default `1000`; limit the number of fields, set Infinity for unlimited
-- `options.maxFieldsSize` **{number}** - default `20 * 1024 * 1024` (20mb);
-  limit the amount of memory all fields together (except files) can allocate in
-  bytes.
-- `options.hashAlgorithm` **{string | false}** - default `false`; include checksums calculated
-  for incoming files, set this to some hash algorithm, see
-  [crypto.createHash](https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options)
-  for available algorithms
-- `options.fileWriteStreamHandler` **{function}** - default `null`, which by
-  default writes to host machine file system every file parsed; The function
-  should return an instance of a
-  [Writable stream](https://nodejs.org/api/stream.html#stream_class_stream_writable)
-  that will receive the uploaded file data. With this option, you can have any
-  custom behavior regarding where the uploaded file data will be streamed for.
-  If you are looking to write the file uploaded in other types of cloud storages
-  (AWS S3, Azure blob storage, Google cloud storage) or private file storage,
-  this is the option you're looking for. When this option is defined the default
-  behavior of writing the file in the host machine file system is lost.
-- `options.filename` **{function}** - default `undefined` Use it to control
-  newFilename. Must return a string. Will be joined with options.uploadDir.
-
-- `options.filter` **{function}** - default function that always returns true.
-  Use it to filter files before they are uploaded. Must return a boolean. Will not make the form.parse error
-
-- `options.createDirsFromUploads` **{boolean}** - default false. If true, makes direct folder uploads possible. Use `<input type="file" name="folders" webkitdirectory directory multiple>` to create a form to upload folders. Has to be used with the options `options.uploadDir` and `options.filename` where `options.filename` has to return a string with the character `/` for folders to be created. The base will be `options.uploadDir`.
-
-
-#### `options.filename`  **{function}** function (name, ext, part, form) -> string
-
-where part can be decomposed as
-
-```js
-const { originalFilename, mimetype} = part;
-```
-
-_**Note:** If this size of combined fields, or size of some file is exceeded, an
-`'error'` event is fired._
-
-```js
-// The amount of bytes received for this form so far.
-form.bytesReceived;
-```
-
-```js
-// The expected number of bytes in this form.
-form.bytesExpected;
-```
-
-#### `options.filter`  **{function}** function ({name, originalFilename, mimetype}) -> boolean
-
-Behaves like Array.filter: Returning false will simply ignore the file and go to the next.
-
-```js
-const options = {
-  filter: function ({name, originalFilename, mimetype}) {
-    // keep only images
-    return mimetype && mimetype.includes("image");
-  }
-};
-```
-
-**Note:** use an outside variable to cancel all uploads upon the first error
-
-**Note:** use form.emit('error') to make form.parse error
-
-```js
-let cancelUploads = false;// create variable at the same scope as form
-const options = {
-  filter: function ({name, originalFilename, mimetype}) {
-    // keep only images
-    const valid = mimetype && mimetype.includes("image");
-    if (!valid) {
-      form.emit('error', new formidableErrors.default('invalid type', 0, 400)); // optional make form.parse error
-      cancelUploads = true; //variable to make filter return false after the first problem
-    }
-    return valid && !cancelUploads;
-  }
-};
-```
-
-
-### .parse(request, ?callback)
-
-Parses an incoming Node.js `request` containing form data. If `callback` is not provided a promise is returned.
-
-```js
-const form = formidable({ uploadDir: __dirname });
-
-form.parse(req, (err, fields, files) => {
-  console.log('fields:', fields);
-  console.log('files:', files);
-});
-
-// with Promise
-const [fields, files] = await form.parse(req);
-```
-
-You may overwrite this method if you are interested in directly accessing the
-multipart stream. Doing so will disable any `'field'` / `'file'` events
-processing which would occur otherwise, making you fully responsible for
-handling the processing.
-
-About `uploadDir`, given the following directory structure 
-```
-project-name
-├── src
-│   └── server.js
-│       
-└── uploads
-    └── image.jpg
-```
-
-`__dirname` would be the same directory as the source file itself (src)
-
-
-```js
- `${__dirname}/../uploads`
-```
-
-to put files in uploads.
-
-Omitting `__dirname` would make the path relative to the current working directory. This would be the same if server.js is launched from src but not project-name.
-
-
-`null` will use default which is `os.tmpdir()`
-
-Note: If the directory does not exist, the uploaded files are __silently discarded__. To make sure it exists:
-
-```js
-import {createNecessaryDirectoriesSync} from "filesac";
-
-
-const uploadPath = `${__dirname}/../uploads`;
-createNecessaryDirectoriesSync(`${uploadPath}/x`);
-```
-
-
-In the example below, we listen on couple of events and direct them to the
-`data` listener, so you can do whatever you choose there, based on whether its
-before the file been emitted, the header value, the header name, on field, on
-file and etc.
-
-Or the other way could be to just override the `form.onPart` as it's shown a bit
-later.
-
-```js
-form.once('error', console.error);
-
-form.on('fileBegin', (formname, file) => {
-  form.emit('data', { name: 'fileBegin', formname, value: file });
-});
-
-form.on('file', (formname, file) => {
-  form.emit('data', { name: 'file', formname, value: file });
-});
-
-form.on('field', (fieldName, fieldValue) => {
-  form.emit('data', { name: 'field', key: fieldName, value: fieldValue });
-});
-
-form.once('end', () => {
-  console.log('Done!');
-});
-
-// If you want to customize whatever you want...
-form.on('data', ({ name, key, value, buffer, start, end, formname, ...more }) => {
-  if (name === 'partBegin') {
-  }
-  if (name === 'partData') {
-  }
-  if (name === 'headerField') {
-  }
-  if (name === 'headerValue') {
-  }
-  if (name === 'headerEnd') {
-  }
-  if (name === 'headersEnd') {
-  }
-  if (name === 'field') {
-    console.log('field name:', key);
-    console.log('field value:', value);
-  }
-  if (name === 'file') {
-    console.log('file:', formname, value);
-  }
-  if (name === 'fileBegin') {
-    console.log('fileBegin:', formname, value);
-  }
-});
-```
-
-### .use(plugin: Plugin)
-
-A method that allows you to extend the Formidable library. By default we include
-4 plugins, which essentially are adapters to plug the different built-in parsers.
-
-**The plugins added by this method are always enabled.**
-
-_See [src/plugins/](./src/plugins/) for more detailed look on default plugins._
-
-The `plugin` param has such signature:
-
-```typescript
-function(formidable: Formidable, options: Options): void;
-```
-
-The architecture is simple. The `plugin` is a function that is passed with the
-Formidable instance (the `form` across the README examples) and the options.
-
-**Note:** the plugin function's `this` context is also the same instance.
-
-```js
-const form = formidable({ keepExtensions: true });
-
-form.use((self, options) => {
-  // self === this === form
-  console.log('woohoo, custom plugin');
-  // do your stuff; check `src/plugins` for inspiration
-});
-
-form.parse(req, (error, fields, files) => {
-  console.log('done!');
-});
-```
-
-**Important to note**, is that inside plugin `this.options`, `self.options` and
-`options` MAY or MAY NOT be the same. General best practice is to always use the
-`this`, so you can later test your plugin independently and more easily.
-
-If you want to disable some parsing capabilities of Formidable, you can disable
-the plugin which corresponds to the parser. For example, if you want to disable
-multipart parsing (so the [src/parsers/Multipart.js](./src/parsers/Multipart.js)
-which is used in [src/plugins/multipart.js](./src/plugins/multipart.js)), then
-you can remove it from the `options.enabledPlugins`, like so
-
-```js
-import formidable, {octetstream, querystring, json} from "formidable";
-const form = formidable({
-  hashAlgorithm: 'sha1',
-  enabledPlugins: [octetstream, querystring, json],
-});
-```
-
-**Be aware** that the order _MAY_ be important too. The names corresponds 1:1 to
-files in [src/plugins/](./src/plugins) folder.
-
-Pull requests for new built-in plugins MAY be accepted - for example, more
-advanced querystring parser. Add your plugin as a new file in `src/plugins/`
-folder (lowercased) and follow how the other plugins are made.
-
-### form.onPart
-
-If you want to use Formidable to only handle certain parts for you, you can do
-something similar. Or see
-[#387](https://github.com/node-formidable/node-formidable/issues/387) for
-inspiration, you can for example validate the mime-type.
-
-```js
-const form = formidable();
-
-form.onPart = (part) => {
-  part.on('data', (buffer) => {
-    // do whatever you want here
-  });
-};
-```
-
-For example, force Formidable to be used only on non-file "parts" (i.e., html
-fields)
-
-```js
-const form = formidable();
-
-form.onPart = function (part) {
-  // let formidable handle only non-file parts
-  if (part.originalFilename === '' || !part.mimetype) {
-    // used internally, please do not override!
-    form._handlePart(part);
-  }
-};
-```
-
-### File
-
-```ts
-export interface File {
-  // The size of the uploaded file in bytes.
-  // If the file is still being uploaded (see `'fileBegin'` event),
-  // this property says how many bytes of the file have been written to disk yet.
-  file.size: number;
-
-  // The path this file is being written to. You can modify this in the `'fileBegin'` event in
-  // case you are unhappy with the way formidable generates a temporary path for your files.
-  file.filepath: string;
-
-  // The name this file had according to the uploading client.
-  file.originalFilename: string | null;
-  
-  // calculated based on options provided
-  file.newFilename: string | null;
-
-  // The mime type of this file, according to the uploading client.
-  file.mimetype: string | null;
-
-  // A Date object (or `null`) containing the time this file was last written to.
-  // Mostly here for compatibility with the [W3C File API Draft](http://dev.w3.org/2006/webapi/FileAPI/).
-  file.mtime: Date | null;
-
-  file.hashAlgorithm: false | |'sha1' | 'md5' | 'sha256'
-  // If `options.hashAlgorithm` calculation was set, you can read the hex digest out of this var (at the end it will be a string)
-  file.hash: string | object | null;
-}
-```
-
-#### file.toJSON()
-
-This method returns a JSON-representation of the file, allowing you to
-`JSON.stringify()` the file which is useful for logging and responding to
-requests.
-
-### Events
-
-#### `'progress'`
-
-Emitted after each incoming chunk of data that has been parsed. Can be used to
-roll your own progress bar. **Warning** Use this only for server side progress bar. On the client side better use `XMLHttpRequest` with `xhr.upload.onprogress =`
-
-```js
-form.on('progress', (bytesReceived, bytesExpected) => {});
-```
-
-#### `'field'`
-
-Emitted whenever a field / value pair has been received.
-
-```js
-form.on('field', (name, value) => {});
-```
-
-#### `'fileBegin'`
-
-Emitted whenever a new file is detected in the upload stream. Use this event if
-you want to stream the file to somewhere else while buffering the upload on the
-file system.
-
-```js
-form.on('fileBegin', (formName, file) => {
-    // accessible here 
-    // formName the name in the form (<input name="thisname" type="file">) or http filename for octetstream
-    // file.originalFilename http filename or null if there was a parsing error
-    // file.newFilename generated hexoid or what options.filename returned
-    // file.filepath default pathname as per options.uploadDir and options.filename
-    // file.filepath = CUSTOM_PATH // to change the final path
-});
-```
-
-#### `'file'`
-
-Emitted whenever a field / file pair has been received. `file` is an instance of
-`File`.
-
-```js
-form.on('file', (formname, file) => {
-    // same as fileBegin, except
-    // it is too late to change file.filepath
-    // file.hash is available if options.hash was used
-});
-```
-
-#### `'error'`
-
-Emitted when there is an error processing the incoming form. A request that
-experiences an error is automatically paused, you will have to manually call
-`request.resume()` if you want the request to continue firing `'data'` events.
-
-May have `error.httpCode` and `error.code` attached.
-
-```js
-form.on('error', (err) => {});
-```
-
-#### `'aborted'`
-
-Emitted when the request was aborted by the user. Right now this can be due to a
-'timeout' or 'close' event on the socket. After this event is emitted, an
-`error` event will follow. In the future there will be a separate 'timeout'
-event (needs a change in the node core).
-
-```js
-form.on('aborted', () => {});
-```
-
-#### `'end'`
-
-Emitted when the entire request has been received, and all contained files have
-finished flushing to disk. This is a great place for you to send your response.
-
-```js
-form.on('end', () => {});
-```
-
-
-### Helpers
-
-#### firstValues
-
-Gets first values of fields, like pre 3.0.0 without multiples pass in a list of optional exceptions where arrays of strings is still wanted (`<select multiple>` for example)
-
-```js
-import { firstValues } from 'formidable/src/helpers/firstValues.js';
-
-// ...
-form.parse(request, async (error, fieldsMultiple, files) => {
-    if (error) {
-        //...
-    }
-    const exceptions = ['thisshouldbeanarray'];
-    const fieldsSingle = firstValues(form, fieldsMultiple, exceptions);
-    // ...
-```
-
-#### readBooleans
-
-Html form input type="checkbox" only send the value "on" if checked,
-convert it to booleans for each input that is expected to be sent as a checkbox, only use after firstValues or similar was called.
-
-```js
-import { firstValues } from 'formidable/src/helpers/firstValues.js';
-import { readBooleans } from 'formidable/src/helpers/readBooleans.js';
-
-// ...
-form.parse(request, async (error, fieldsMultiple, files) => {
-    if (error) {
-        //...
-    }
-    const fieldsSingle = firstValues(form, fieldsMultiple);
-    
-    const expectedBooleans = ['checkbox1', 'wantsNewsLetter', 'hasACar'];
-    const fieldsWithBooleans = readBooleans(fieldsSingle, expectedBooleans);
-    // ...
-```
-
-## Changelog
-
-[./CHANGELOG.md](./CHANGELOG.md)
-
-## Ports & Credits
-
-- [multipart-parser](http://github.com/FooBarWidget/multipart-parser): a C++
-  parser based on formidable
-- [Ryan Dahl](http://twitter.com/ryah) for his work on
-  [http-parser](http://github.com/ry/http-parser) which heavily inspired the
-  initial `multipart_parser.js`.
-
-## Contributing
-
-If the documentation is unclear or has a typo, please click on the page's `Edit`
-button (pencil icon) and suggest a correction. If you would like to help us fix
-a bug or add a new feature, please check our [Contributing
-Guide][contributing-url]. Pull requests are welcome!
-
-Thanks goes to these wonderful people
-([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="https://twitter.com/felixge"><img src="https://avatars3.githubusercontent.com/u/15000?s=460&v=4" width="100px;" alt=""/><br /><sub><b>Felix Geisendörfer</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/commits?author=felixge" title="Code">💻</a> <a href="#design-felixge" title="Design">🎨</a> <a href="#ideas-felixge" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=felixge" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://tunnckoCore.com"><img src="https://avatars3.githubusercontent.com/u/5038030?v=4" width="100px;" alt=""/><br /><sub><b>Charlike Mike Reagent</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/issues?q=author%3AtunnckoCore" title="Bug reports">🐛</a> <a href="#infra-tunnckoCore" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#design-tunnckoCore" title="Design">🎨</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=tunnckoCore" title="Code">💻</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=tunnckoCore" title="Documentation">📖</a> <a href="#example-tunnckoCore" title="Examples">💡</a> <a href="#ideas-tunnckoCore" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-tunnckoCore" title="Maintenance">🚧</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=tunnckoCore" title="Tests">⚠️</a></td>
-    <td align="center"><a href="https://github.com/kedarv"><img src="https://avatars1.githubusercontent.com/u/1365665?v=4" width="100px;" alt=""/><br /><sub><b>Kedar</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/commits?author=kedarv" title="Code">💻</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=kedarv" title="Tests">⚠️</a> <a href="#question-kedarv" title="Answering Questions">💬</a> <a href="https://github.com/node-formidable/node-formidable/issues?q=author%3Akedarv" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/GrosSacASac"><img src="https://avatars0.githubusercontent.com/u/5721194?v=4" width="100px;" alt=""/><br /><sub><b>Walle Cyril</b></sub></a><br /><a href="#question-GrosSacASac" title="Answering Questions">💬</a> <a href="https://github.com/node-formidable/node-formidable/issues?q=author%3AGrosSacASac" title="Bug reports">🐛</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=GrosSacASac" title="Code">💻</a> <a href="#financial-GrosSacASac" title="Financial">💵</a> <a href="#ideas-GrosSacASac" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-GrosSacASac" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="https://github.com/xarguments"><img src="https://avatars2.githubusercontent.com/u/40522463?v=4" width="100px;" alt=""/><br /><sub><b>Xargs</b></sub></a><br /><a href="#question-xarguments" title="Answering Questions">💬</a> <a href="https://github.com/node-formidable/node-formidable/issues?q=author%3Axarguments" title="Bug reports">🐛</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=xarguments" title="Code">💻</a> <a href="#maintenance-xarguments" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="https://github.com/Amit-A"><img src="https://avatars1.githubusercontent.com/u/7987238?v=4" width="100px;" alt=""/><br /><sub><b>Amit-A</b></sub></a><br /><a href="#question-Amit-A" title="Answering Questions">💬</a> <a href="https://github.com/node-formidable/node-formidable/issues?q=author%3AAmit-A" title="Bug reports">🐛</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=Amit-A" title="Code">💻</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="https://charmander.me/"><img src="https://avatars1.githubusercontent.com/u/1889843?v=4" width="100px;" alt=""/><br /><sub><b>Charmander</b></sub></a><br /><a href="#question-charmander" title="Answering Questions">💬</a> <a href="https://github.com/node-formidable/node-formidable/issues?q=author%3Acharmander" title="Bug reports">🐛</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=charmander" title="Code">💻</a> <a href="#ideas-charmander" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-charmander" title="Maintenance">🚧</a></td>
-    <td align="center"><a href="https://twitter.com/dylan_piercey"><img src="https://avatars2.githubusercontent.com/u/4985201?v=4" width="100px;" alt=""/><br /><sub><b>Dylan Piercey</b></sub></a><br /><a href="#ideas-DylanPiercey" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="http://ochrona.jawne.info.pl"><img src="https://avatars1.githubusercontent.com/u/3618479?v=4" width="100px;" alt=""/><br /><sub><b>Adam Dobrawy</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/issues?q=author%3Aad-m" title="Bug reports">🐛</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=ad-m" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/amitrohatgi"><img src="https://avatars3.githubusercontent.com/u/12177021?v=4" width="100px;" alt=""/><br /><sub><b>amitrohatgi</b></sub></a><br /><a href="#ideas-amitrohatgi" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="https://github.com/fengxinming"><img src="https://avatars2.githubusercontent.com/u/6262382?v=4" width="100px;" alt=""/><br /><sub><b>Jesse Feng</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/issues?q=author%3Afengxinming" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://qtmsheep.com"><img src="https://avatars1.githubusercontent.com/u/7271496?v=4" width="100px;" alt=""/><br /><sub><b>Nathanael Demacon</b></sub></a><br /><a href="#question-quantumsheep" title="Answering Questions">💬</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=quantumsheep" title="Code">💻</a> <a href="https://github.com/node-formidable/node-formidable/pulls?q=is%3Apr+reviewed-by%3Aquantumsheep" title="Reviewed Pull Requests">👀</a></td>
-  </tr>
-  <tr>
-    <td align="center"><a href="https://github.com/MunMunMiao"><img src="https://avatars1.githubusercontent.com/u/18216142?v=4" width="100px;" alt=""/><br /><sub><b>MunMunMiao</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/issues?q=author%3AMunMunMiao" title="Bug reports">🐛</a></td>
-    <td align="center"><a href="https://github.com/gabipetrovay"><img src="https://avatars0.githubusercontent.com/u/1170398?v=4" width="100px;" alt=""/><br /><sub><b>Gabriel Petrovay</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/issues?q=author%3Agabipetrovay" title="Bug reports">🐛</a> <a href="https://github.com/node-formidable/node-formidable/commits?author=gabipetrovay" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/Elzair"><img src="https://avatars0.githubusercontent.com/u/2352818?v=4" width="100px;" alt=""/><br /><sub><b>Philip Woods</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/commits?author=Elzair" title="Code">💻</a> <a href="#ideas-Elzair" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="https://github.com/dmolim"><img src="https://avatars2.githubusercontent.com/u/7090374?v=4" width="100px;" alt=""/><br /><sub><b>Dmitry Ivonin</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/commits?author=dmolim" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://audiobox.fm"><img src="https://avatars1.githubusercontent.com/u/12844?v=4" width="100px;" alt=""/><br /><sub><b>Claudio Poli</b></sub></a><br /><a href="https://github.com/node-formidable/node-formidable/commits?author=masterkain" title="Code">💻</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-enable -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-From a [Felix blog post](https://felixge.de/2013/03/11/the-pull-request-hack/):
-
-- [Sven Lito](https://github.com/svnlto) for fixing bugs and merging patches
-- [egirshov](https://github.com/egirshov) for contributing many improvements to the node-formidable multipart parser
-- [Andrew Kelley](https://github.com/superjoe30) for also helping with fixing bugs and making improvements
-- [Mike Frey](https://github.com/mikefrey) for contributing JSON support
-
-## License
-
-Formidable is licensed under the [MIT License][license-url].
-
-<!-- badges -->
-<!-- prettier-ignore-start -->
-
-[codestyle-url]: https://github.com/airbnb/javascript
-[codestyle-img]: https://badgen.net/badge/code%20style/airbnb%20%2B%20prettier/ff5a5f?icon=airbnb&cache=300
-[codecov-url]: https://codecov.io/gh/node-formidable/formidable
-[codecov-img]: https://badgen.net/codecov/c/github/node-formidable/formidable/master?icon=codecov
-[npmv-canary-img]: https://badgen.net/npm/v/formidable/canary?icon=npm
-[npmv-dev-img]: https://badgen.net/npm/v/formidable/dev?icon=npm
-[npmv-img]: https://badgen.net/npm/v/formidable?icon=npm
-[npmv-url]: https://npmjs.com/package/formidable
-[license-img]: https://badgen.net/npm/license/formidable
-[license-url]: https://github.com/node-formidable/formidable/blob/master/LICENSE
-[chat-img]: https://badgen.net/badge/chat/on%20gitter/46BC99?icon=gitter
-[chat-url]: https://gitter.im/node-formidable/Lobby
-[libera-manifesto-url]: https://liberamanifesto.com
-[libera-manifesto-img]: https://badgen.net/badge/libera/manifesto/grey
-[renovateapp-url]: https://renovatebot.com
-[renovateapp-img]: https://badgen.net/badge/renovate/enabled/green?cache=300
-[prs-welcome-img]: https://badgen.net/badge/PRs/welcome/green?cache=300
-[prs-welcome-url]: http://makeapullrequest.com
-[twitter-url]: https://twitter.com/3a1fcBx0
-[twitter-img]: https://badgen.net/twitter/follow/3a1fcBx0?icon=twitter&color=1da1f2&cache=300
-
-[npm-weekly-img]: https://badgen.net/npm/dw/formidable?icon=npm&cache=300
-[npm-monthly-img]: https://badgen.net/npm/dm/formidable?icon=npm&cache=300
-[npm-yearly-img]: https://badgen.net/npm/dy/formidable?icon=npm&cache=300
-[npm-alltime-img]: https://badgen.net/npm/dt/formidable?icon=npm&cache=300&label=total%20downloads
-
-[nodejs-img]: https://badgen.net/badge/node/>=%2010.13/green?cache=300
-
-[ccommits-url]: https://conventionalcommits.org/
-[ccommits-img]: https://badgen.net/badge/conventional%20commits/v1.0.0/green?cache=300
-
-[contributing-url]: https://github.com/node-formidable/.github/blob/master/CONTRIBUTING.md
-[code_of_conduct-url]: https://github.com/node-formidable/.github/blob/master/CODE_OF_CONDUCT.md
-
-[open-issue-url]: https://github.com/node-formidable/formidable/issues/new
-
-[tidelift-url]: https://tidelift.com/subscription/pkg/npm-formidable?utm_source=npm-formidable&utm_medium=referral&utm_campaign=enterprise
-[tidelift-img]: https://badgen.net/badge/tidelift/subscription/4B5168?labelColor=F6914D
-
-[kofi-url]: https://ko-fi.com/tunnckoCore/commissions
-[kofi-img]: https://badgen.net/badge/ko-fi/support/29abe0c2?cache=300&icon=https://rawcdn.githack.com/tunnckoCore/badgen-icons/f8264c6414e0bec449dd86f2241d50a9b89a1203/icons/kofi.svg
-
-[linux-build-img]: https://badgen.net/github/checks/node-formidable/formidable/master/ubuntu?cache=300&label=linux%20build&icon=github
-[macos-build-img]: https://badgen.net/github/checks/node-formidable/formidable/master/macos?cache=300&label=macos%20build&icon=github
-[windows-build-img]: https://badgen.net/github/checks/node-formidable/formidable/master/windows?cache=300&label=windows%20build&icon=github
-[build-url]: https://github.com/node-formidable/formidable/actions?query=workflow%3Anodejs
-<!-- prettier-ignore-end -->