Skip to content

Commit e811eb9

Browse files
committed
Add documentation for Encoder#values() method.
1 parent a9bd095 commit e811eb9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

readme.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,9 +316,19 @@ Returns headers object with Content-Type and Content-Length header
316316

317317
#### Instance methods
318318

319+
##### `values() -> {Generator<Uint8Array | FileLike, void, undefined>}`
320+
321+
Creates an iterator allowing to go through form-data parts (with metadata).
322+
This method **will not** read the files.
323+
319324
##### `encode() -> {AsyncGenerator<Uint8Array, void, undefined>}`
320325

321326
Creates an async iterator allowing to perform the encoding by portions.
327+
This method **will** also read files.
328+
329+
##### `[Symbol.iterator]() -> {Generator<Uint8Array | FileLike, void, undefined>}`
330+
331+
An alias for `Encoder#values()` method.
322332

323333
##### `[Symbol.asyncIterator]() -> {AsyncGenerator<Uint8Array, void, undefined>}`
324334

0 commit comments

Comments
 (0)