feat(types): add types file #2398
Open
+2,148
−1
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
|
Having types file here will make sure the types and codebase are in sync. |
|
LGTM. Could you please also add some guidelines on how to use, on the README? Perhaps adding a section for Types? |
|
Sure thing. I will update the readme for this |
|
Since the types get installed along with the library, there is no need to install @types/validator package anymore for typescript support. I have added a small section on readme for that but we should also point this on the realease notes @profnandaa |
profnandaa
reviewed
Jun 1, 2024
| @@ -43,6 +43,9 @@ Or, import only a subset of the library: | |||
| import isEmail from 'validator/lib/isEmail'; | |||
| ``` | |||
|
|
|||
| #### Types | |||
| Starting the latest version of validator.js , the types comes out of box. | |||
There was a problem hiding this comment.
nit: perhaps can add a small sample typescript code block? this could be more beginner friendly.
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.
This PR adds types file within the repo itself .
The types file is derived from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/validator
with some modifications
Checklist