Update TS types definitions #181
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
icebob
reviewed
Jul 10, 2022
fakerator.d.ts
Outdated
| @@ -104,7 +103,7 @@ declare module 'fakerator' { | |||
| * @param precision Can generate floating number if you define this parameter. Note: Do not use 0 | |||
| * @returns number | |||
| */ | |||
| number(min: number, max: number, precision: number = 1): number; | |||
| number(min: number, max: number, precision: number): number; | |||
There was a problem hiding this comment.
Why do you remove the default value of method parameters?
They are not a valid TS construct. Default values are only for runtime declarations, not type declarations. Actually I just realized the function parameters with default values should be optional
Suggested change
| number(min: number, max: number, precision: number): number; | |
| number(min: number, max: number, precision?: number): number; |
| @@ -104,7 +103,7 @@ declare module 'fakerator' { | |||
| * @param precision Can generate floating number if you define this parameter. Note: Do not use 0 | |||
There was a problem hiding this comment.
Why do you remove the default value of method parameters?
I can add default value as part of the JSDoc documentation so it can be useful for intellisense
Suggested change
| * @param precision Can generate floating number if you define this parameter. Note: Do not use 0 | |
| * @param {number} [precision=1] Can generate floating number if you define this parameter. Note: Do not use 0 |
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.
Solves #180, #179 and #177
Updates TS definitions according to [email protected]