Feature/simplify api #15
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
Closed
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.
xk6-faker
v0.3.0is here with a new JavaScript-like API 🎉!This release includes:
Breaking changes
New JavaScript-like API
One of the goals of the refactor is to replace the previous xk6-faker API, which mirrors the underlying go library API, with an API similar to the popular JavaScript faker libraries.
Another important goal was to increase maintainability. The previous implementation contained a lot of manually created, difficult-to-maintain code and test code. After the refactor, the codes and test codes that required a lot of manual work disappeared, code generation replaces them in many places.
New features
API doc generated by TypeDoc
The new API documentation website is much clearer and easier to use than the previous documentation. The generation is done using TypeDoc, which can be considered standard, so the appearance is similar to that of the usual TypeScript API documentation sites.