Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add synchronous build method #110

Merged
merged 1 commit into from
Sep 4, 2020
Merged

Add synchronous build method #110

merged 1 commit into from
Sep 4, 2020

Conversation

10xjs
Copy link
Contributor

@10xjs 10xjs commented Sep 3, 2020

Add a new buildSync method alongside the existing build method to allow the generator to be used where synchronous flow is required.

This is a simple non-breaking surface-level change. The library does not currently include any internal async logic. The async behavior of the build method is designed to avoid an unwanted breaking interface change in the future if async logic is added (discussed here). If async generators are added in the future, I suggest that they be excluded from the set of generators available for use when calling buildSync - this could be achieved cleanly in typescript by giving the Mocker class a generic Schema type that is referenced in conditional types on the build and buildSync methods. This would also require adding strict type inference to the schema interface, but doing so could have the added benefit of returning non-opaque typed data.

Add a new `buildSync` method alongside the existing `build` method to allow the generator to be used where synchronous flow is required.

This is a simple non-breaking surface-level change. The library does not currently include any internal async logic. The async behavior of the `build` method is designed to avoid an unwanted breaking interface change in the future if async logic is added (discussed [here](danibram#100)). If async generators are added in the future, I suggest that they be excluded from the set of generators available for use when calling `buildSync` - this could be achieved cleanly in typescript by giving the `Mocker` class a generic `Schema` type that is referenced in conditional types on the `build` and `buildSync` methods. This would also require adding strict type inference to the schema interface, but doing so could have the added benefit of returning non-opaque typed data.
@10xjs
Copy link
Contributor Author

10xjs commented Sep 3, 2020

this node 14.x bug appears to be causing the CI execution to fail

@10xjs 10xjs force-pushed the master branch 4 times, most recently from 24bf8c6 to 772b20d Compare September 3, 2020 21:49
@10xjs
Copy link
Contributor Author

10xjs commented Sep 3, 2020

CI will continue to fail pending the fix in #112

@danibram
Copy link
Owner

danibram commented Sep 4, 2020

Nice work @10xjs! Thanks!

@danibram danibram merged commit ae88bb7 into danibram:master Sep 4, 2020
@danibram
Copy link
Owner

danibram commented Sep 4, 2020

Live in v2.9.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants