🏷️ Standardize exported typings and add missing ones #902
+188
−111
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
In an attempt to prevent the script `docs` from issuing any warnings, we had to add some missing typings into our API: - AsyncPropertyHookFunction - PropertyHookFunction - RunDetailsCommon - DedupValue - FrequencyValue - OneOfValue - RecordValue - ModelRunSetup - ModelRunAsyncSetup - ArbitraryWithShrink - CommandsConstraints - PreconditionFailure - RandomType But also to rename some existing ones (still available under their old name but marked as deprecated): - Context -> ContextValue - FalsyType -> FalsyValue And also revamp internal ones to use the same naming rules. We also restructure the file `fast-check-default.ts` to better categorize and distinguish items related to constraints, output, configuration and others (purely re-ordering of exports and comments).
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 01ae8aa:
|
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.
In an attempt to prevent the script
docsfrom issuing any warnings, we had to add some missing typings into our API:But also to rename some existing ones (still available under their old name but marked as deprecated):
And also revamp internal ones to use the same naming rules.
We also restructure the file
fast-check-default.tsto better categorize and distinguish items related to constraints, output, configuration and others (purely re-ordering of exports and comments).In a nutshell
❌ New feature
❌ Fix an issue
✔️ Documentation improvement
❌ Other: please explain
(✔️: yes, ❌: no)
Potential impacts
None.
Perhaps some non-expected ones on typings.