Redesign and expose the internal API #16
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
The internal API is reworked and exposed to give the ability to use `dotenv-flow` programmatically. BREAKING CHANGE: The `.parse` method's signature is changed. Now it takes the filename or a list of filenames to parse.
Add documentation for the newly exposed API.
…cal` Fix test cases of the `.config()` method regarding to the `.env.local` file.
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.
I've reworked the internal API to expose it giving the ability to use
dotenv-flowprogrammatically.The
.configmethod (the main entry point) with all its options remains full backward-compatibility.The only "breaking change" is the
.parsemethod's signature. Now it takes the filename or a list of filenames to parse.The following new methods became available:
.listDotenvFiles(dirname, { node_env });.load(filename(s), { encoding });.unload(filename(s), { encoding });This changes will be released as a new major version (
v3.0.0).Any suggestions regarding to this PR would be appreciated.