grafana / xk6-faker

Random fake data generator for k6.
https://faker.x.k6.io
GNU Affero General Public License v3.0
59 stars 18 forks source link

Feature/simplify api #15

Closed szkiba closed 8 months ago

szkiba commented 8 months ago

xk6-faker v0.3.0 is 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.