Fix return type annotations for the random() method #492
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.
The
random()
method on a type generates a random value conforming to the type of the schema. The TypeScript type definitions for this method were incorrect - they claimed that this method returned the type object itself. For instance, calling random on aBooleanType
returns aboolean
, not aBooleanType
. I assume this has gone undetected for years, because this method is rarely used.Because the types for schemas do not carry complex type information in generics, many of these return types are rather imprecise. I have had to resort to
unknown
quite often, because more exact types are not available. I have choseunknown
overany
, to maintain type safety.