|
| 1 | +# formidable@next |
| 2 | + |
| 3 | +v4 preparations. Modern multipart form-data parser for Node.js, Bun, Deno, Cloudflare, and the |
| 4 | +browser. |
| 5 | + |
| 6 | +> [!CAUTION] |
| 7 | +> |
| 8 | +> For older Node versions like v14, v15 and v16 you have to use the `web-streams-polyfill` in your |
| 9 | +> project. Minimum required version is the first Node.js v14 LTS release, `v14.15.0` (Fermium). |
| 10 | +
|
| 11 | +## install |
| 12 | + |
| 13 | +``` |
| 14 | +npm i formidable@next |
| 15 | +``` |
| 16 | + |
| 17 | +## Example |
| 18 | + |
| 19 | +```ts |
| 20 | +import { |
| 21 | + parseMultipartRequest, |
| 22 | + parseMultipart, |
| 23 | + formidableDefaultOptions, |
| 24 | + FormidableError, |
| 25 | + FormidableOptions, |
| 26 | + FormidablePart, |
| 27 | +} from 'formidable'; |
| 28 | + |
| 29 | +async function formidable(req: Request, options?: FormidableOptions) { |
| 30 | + try { |
| 31 | + await parseMultipartRequest(req, options, async (part: FormidablePart) => { |
| 32 | + // part.type - part content type, media type (no charsets) |
| 33 | + |
| 34 | + // ==== Headers ==== |
| 35 | + // part.headers - part headers, parsed into type-safe SuperHeaders object |
| 36 | + // part.headers.contentType.mediaType - part content media type |
| 37 | + // part.headers.contentType.charset - part content charset |
| 38 | + // part.headers.contentDisposition.name |
| 39 | + // part.headers.contentDisposition.filename |
| 40 | + // part.headers.contentDisposition.preferredFilename |
| 41 | + // part.headers.contentDisposition.type - attachment or inline or form-data |
| 42 | + |
| 43 | + // ==== Streaming ==== |
| 44 | + // await part.stream() - no buffering, async iterable, useful to use in `for await (const chunk of part.stream())` |
| 45 | + |
| 46 | + // ==== Buffering ==== |
| 47 | + // await part.text(failSafe?) - buffer into string, pass failSafe = true to avoid crashing |
| 48 | + // await part.bytes() - buffer into Uint8Array bytes |
| 49 | + // await part.arrayBuffer() - buffer into ArrayBuffer |
| 50 | + // await part.json() - buffer into JSON object, pass failSafe = true to avoid crashing |
| 51 | + |
| 52 | + // ==== Utils ==== |
| 53 | + // part.toString() - string representing the state of properties (name, filename, type, headers) |
| 54 | + // part.toObject() - the core of `toString()`, returns an object with the properties (name, filename, type, headers) |
| 55 | + // part.isFile() - check if the part is a file |
| 56 | + |
| 57 | + if (part.isFile()) { |
| 58 | + console.log('file', part.name, part.filename, part.toString()); |
| 59 | + } else { |
| 60 | + // part.text() on field gets the input's value |
| 61 | + console.log('field', part.name, await part.text()); |
| 62 | + } |
| 63 | + }); |
| 64 | + } catch (er: FormidableError) { |
| 65 | + switch (er.code) { |
| 66 | + case 'ERR_INVALID_INPUT': |
| 67 | + console.error(er.message); |
| 68 | + break; |
| 69 | + case 'ERR_BODY_CONSUMED': |
| 70 | + console.error(er.message); |
| 71 | + break; |
| 72 | + case 'ERR_FAILED_TO_PARSE_TEXT': |
| 73 | + console.error(er.message); |
| 74 | + break; |
| 75 | + case 'ERR_FAILED_TO_PARSE_JSON': |
| 76 | + console.error(er.message); |
| 77 | + break; |
| 78 | + case 'ERR_NO_BOUNDARY': |
| 79 | + console.error(er.message); |
| 80 | + break; |
| 81 | + case 'ERR_MAX_FILENAME_SIZE': |
| 82 | + console.error(er.message); |
| 83 | + break; |
| 84 | + case 'ERR_MAX_FILE_SIZE': |
| 85 | + console.error(er.message); |
| 86 | + break; |
| 87 | + case 'ERR_MAX_FILE_KEY_SIZE': |
| 88 | + console.error(er.message); |
| 89 | + break; |
| 90 | + case 'ERR_MAX_FIELD_SIZE': |
| 91 | + console.error(er.message); |
| 92 | + break; |
| 93 | + case 'ERR_MAX_FIELD_KEY_SIZE': |
| 94 | + console.error(er.message); |
| 95 | + break; |
| 96 | + case 'ERR_MAX_HEADER_SIZE': |
| 97 | + console.error(er.message); |
| 98 | + break; |
| 99 | + case 'ERR_MAX_HEADER_KEY_SIZE': |
| 100 | + console.error(er.message); |
| 101 | + break; |
| 102 | + case 'ERR_MAX_HEADER_VALUE_SIZE': |
| 103 | + console.error(er.message); |
| 104 | + break; |
| 105 | + case 'ERR_MAX_ALL_HEADERS_SIZE': |
| 106 | + console.error(er.message); |
| 107 | + break; |
| 108 | + } |
| 109 | + } |
| 110 | +} |
| 111 | +``` |
| 112 | + |
| 113 | +### Usage in Node.js v14 and v16 |
| 114 | + |
| 115 | +> [!CAUTION] |
| 116 | +> |
| 117 | +> Minimum required version is the first Node.js v14 LTS release, `v14.15.0` (Fermium). |
| 118 | +
|
| 119 | +It bundles the `headers-polyfill` for compatibility with older Node.js versions. For Node.js v14 it |
| 120 | +bundles both; for Node.js v16 you have to `import 'web-streams-polyfill/polyfill';` for ESM, or |
| 121 | +modules `require('web-streams-polyfill/ponyfill');` for CJS |
| 122 | + |
| 123 | +```ts |
| 124 | +import 'web-streams-polyfill/polyfill'; |
| 125 | +import { createServer } from 'node:http'; |
| 126 | +import { parseMultipartRequest } from 'formidable'; |
| 127 | + |
| 128 | +const server = createServer((req, res) => { |
| 129 | + if (req.method === 'POST') { |
| 130 | + // considering the above `formidable` |
| 131 | + await parseMultipartRequest( |
| 132 | + req, |
| 133 | + { |
| 134 | + maxFileSize: 1 * 1024 * 1024, // 1mb, defaults to 100mb |
| 135 | + maxFilenameSize: 1000, // defaults to 255 |
| 136 | + maxFileKeySize: 1000, // defaults to 255 |
| 137 | + maxFieldKeySize: 1000, // defaults to 255 |
| 138 | + }, |
| 139 | + async (part) => { |
| 140 | + console.log('part:', part.toString()); |
| 141 | + }, |
| 142 | + ); |
| 143 | + } else { |
| 144 | + res.writeHead(200, { 'Content-Type': 'text/plain' }); |
| 145 | + res.end('Hello World\n'); |
| 146 | + } |
| 147 | +}); |
| 148 | + |
| 149 | +server.listen(3000, () => { |
| 150 | + console.log('Server running at http://localhost:3000'); |
| 151 | +}); |
| 152 | +``` |
| 153 | + |
| 154 | +### Usage in modern Node.js and other runtimes |
| 155 | + |
| 156 | +You can either use the above helper `formidable` function or the `parseMultipartRequest` directly, |
| 157 | +works on any Fetch/Request/Response API compatible runtime. |
| 158 | + |
| 159 | +- for Node.js v18+, you can use the `formidable` import directly |
| 160 | +- for Bun, Deno, Cloudflare, and the browser, you can use the `formidable` import too |
| 161 | + |
| 162 | +```ts |
| 163 | +// Deno/Bun/Cloudflare |
| 164 | +import { parseMultipartRequest } from 'formidable'; |
| 165 | + |
| 166 | +export default { |
| 167 | + async fetch(req: Request) { |
| 168 | + if (req.method === 'POST') { |
| 169 | + await parseMultipartRequest( |
| 170 | + req, |
| 171 | + { |
| 172 | + maxFileSize: 1 * 1024 * 1024, // 1mb, defaults to 100mb |
| 173 | + maxFilenameSize: 1000, // defaults to 255 |
| 174 | + maxFileKeySize: 1000, // defaults to 255 |
| 175 | + maxFieldKeySize: 1000, // defaults to 255 |
| 176 | + }, |
| 177 | + async (part: FormidablePart) => { |
| 178 | + console.log('part:', part.toString()); |
| 179 | + }, |
| 180 | + ); |
| 181 | + |
| 182 | + return new Response('ok'); |
| 183 | + } |
| 184 | + |
| 185 | + return new Response('Hello World, try POST request', { |
| 186 | + status: 200, |
| 187 | + headers: { |
| 188 | + 'Content-Type': 'text/plain', |
| 189 | + }, |
| 190 | + }); |
| 191 | + }, |
| 192 | +}; |
| 193 | +``` |
| 194 | + |
| 195 | +### Options |
| 196 | + |
| 197 | +- `maxAllHeadersSize` **{number}** - size for all headers combined, _(default: 8kb)_ |
| 198 | +- `maxHeaderKeySize` **{number}** - size of the key per each header, _(default: 255)_ |
| 199 | +- `maxHeaderValueSize` **{number}** - size of the value of each header, _(default: 1kb)_ |
| 200 | +- `maxHeaderSize` **{number}** - size of key + value of each header, _(default: 2kb)_ |
| 201 | +- `maxFilenameSize` **{number}** - size of the file original filename, _(default: 255)_ |
| 202 | +- `maxFileKeySize` **{number}** - size of the key of file fields, _(default: 255)_ |
| 203 | +- `maxFileSize` **{number}** - size of each file, _(default: 100mb)_ |
| 204 | +- `maxFieldKeySize` **{number}** - size of the key of text fields, _(default: 255)_ |
| 205 | +- `maxFieldSize` **{number}** - size of each text field value, _(default: 100kb)_ |
0 commit comments