fix: Improve File and FormData types declarations.
#1042
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. `FormData`: * Declare class methods as they should be; * Minor fixes for methods documentation in code; * Remove unnecessary constructor declaration; * Remove unnecessary part from FormData class description; 2. `File`: * Replace getters with readonly properties; * Remove `File.stream()` method, because `File` inherits `Blob` which already has this method; * `FileOptions` interface inherits `BlobOptions` from `@types/node` declarations;
…cription and rename name to fileName.
octet-stream
changed the title
File and FormData types declarations.File and FormData types declarations.
ronag
approved these changes
Sep 21, 2021
szmarczak
reviewed
Sep 21, 2021
szmarczak
reviewed
Sep 21, 2021
Codecov Report
@@ Coverage Diff @@
## main #1042 +/- ##
==========================================
+ Coverage 94.89% 94.92% +0.02%
==========================================
Files 37 37
Lines 3623 3643 +20
==========================================
+ Hits 3438 3458 +20
Misses 185 185
Continue to review full report at Codecov.
|
…MDN documentation.
KhafraDev
pushed a commit
to KhafraDev/undici
that referenced
this pull request
Jun 23, 2022
* Fixes for `File` and `FormData` types declarations. 1. `FormData`: * Declare class methods as they should be; * Minor fixes for methods documentation in code; * Remove unnecessary constructor declaration; * Remove unnecessary part from FormData class description; 2. `File`: * Replace getters with readonly properties; * Remove `File.stream()` method, because `File` inherits `Blob` which already has this method; * `FileOptions` interface inherits `BlobOptions` from `@types/node` declarations; * Minor fix for File constructor types delcaration: Update fileBits description and rename name to fileName. * Rename arguments in FormData.forEach type declarations. * Rename ctx argument to thisArg in FormData.forEach() method to match MDN documentation.
crysmags
pushed a commit
to crysmags/undici
that referenced
this pull request
Feb 27, 2024
* Fixes for `File` and `FormData` types declarations. 1. `FormData`: * Declare class methods as they should be; * Minor fixes for methods documentation in code; * Remove unnecessary constructor declaration; * Remove unnecessary part from FormData class description; 2. `File`: * Replace getters with readonly properties; * Remove `File.stream()` method, because `File` inherits `Blob` which already has this method; * `FileOptions` interface inherits `BlobOptions` from `@types/node` declarations; * Minor fix for File constructor types delcaration: Update fileBits description and rename name to fileName. * Rename arguments in FormData.forEach type declarations. * Rename ctx argument to thisArg in FormData.forEach() method to match MDN documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR brings various fixes for FormData and File types declarations, including:
FormData:File:File.stream()method, becauseFileinheritsBlobwhich already has this method;FileOptionsinterface inheritsBlobOptionsfrom@types/nodedeclarations;nameargument inFileconstructor tofileName(based on: https://github.com/microsoft/TypeScript/blob/5546f207c5d20578f1d215ccc110dd42bf8d359b/lib/lib.dom.d.ts#L5220)fileBitsdescription to reflect supported input (based on: https://developer.mozilla.org/en-US/docs/Web/API/File/File)I also noticed both
FileandBlobcan be constructed with objects that have@@iterator, this probably have to be reflected in declarations as well? Both in undici File and@types/nodeSee: https://github.com/web-platform-tests/wpt/blob/30e724ac90157333d34198f0c29131b2e2a6b1da/FileAPI/blob/Blob-constructor.any.js#L58-L105