Skip to content

Commit 597031b

Browse files
committed
Update documentation. Require Node.js v16.5 or higher
1 parent b6cc45a commit 597031b

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
strategy:
3030
matrix:
3131
os: [ubuntu-latest, macOS-latest, windows-latest]
32-
node: [14.x, 16.x, 18.x, 19.x]
32+
node: [16.x, 18.x, 19.x]
3333
runs-on: ${{ matrix.os }}
3434
steps:
3535
- uses: actions/checkout@v3

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"repository": "octet-stream/form-data-encoder",
88
"sideEffects": false,
99
"engines": {
10-
"node": ">= 14.17"
10+
"node": ">= 16.5"
1111
},
1212
"keywords": [
1313
"form-data",

readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -340,12 +340,12 @@ Returns headers object with Content-Type and Content-Length header.
340340
##### `values() -> {Generator<Uint8Array | FileLike, void, undefined>}`
341341

342342
Creates an iterator allowing to go through form-data parts (with metadata).
343-
This method **will not** read the files.
343+
This method **will not** read the files and **will not** split values big into smaller chunks.
344344

345345
##### `encode() -> {AsyncGenerator<Uint8Array, void, undefined>}`
346346

347347
Creates an async iterator allowing to perform the encoding by portions.
348-
This method **will** also read files.
348+
This method reads through files and splits big values into smaller pieces (65536 bytes per each).
349349

350350
##### `[Symbol.iterator]() -> {Generator<Uint8Array | FileLike, void, undefined>}`
351351

src/FormDataEncoder.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ export class FormDataEncoder {
265265

266266
/**
267267
* Creates an iterator allowing to go through form-data parts (with metadata).
268-
* This method **will not** read the files.
268+
* This method **will not** read the files and **will not** split values big into smaller chunks.
269269
*
270270
* Using this method, you can convert form-data content into Blob:
271271
*
@@ -317,7 +317,7 @@ export class FormDataEncoder {
317317

318318
/**
319319
* Creates an async iterator allowing to perform the encoding by portions.
320-
* This method **will** also read files.
320+
* This method reads through files and splits big values into smaller pieces (65536 bytes per each).
321321
*
322322
* @example
323323
*

0 commit comments

Comments
 (0)