Improve encodingOrOptions type definition and update the doc #1011
Conversation
This file contains hidden or 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
iBotPeaches
added a commit
to sourcetoad/react-native-fs2
that referenced
this pull request
Dec 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Including in this PR:
Improve typescript and flow type definition for
encodingOrOptions. Changing the type definition fromanyto an union type of encoding string (one of ascii, base64 or utf8) and object.Refactor read / write functions, extract encoding / decoding logic to generic functions:
getEncodingOrOptions,decodeContents,encodeContentsto keep these functions DRY.Upgrade document for
readFile,read,readFileAssets,readFileRes,writeFile,appendFileandwriteto reflect the type definition change and to make them up-to-date with the implementation in FS.common.js.