Documentation for JTDSchemaType #1457
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
epoberezkin
reviewed
Feb 22, 2021
docs/json-type-definition.md
Outdated
| interface MyType { | ||
| num: number; | ||
| optionalStr?: string; | ||
| nullableEnum: "1" | "2"; |
There was a problem hiding this comment.
should it be nullableEnum: "1" | "2" | null
Or am I missing something?
Also, I'd use string strings here, for people accidentally not to think you can use numbers...
|
both of those made sense. Any comment on the typescript in the README? |
looks ok - merging it. Would be good to add example with compile, but let's understand first why it requires explicit type annotation (question in another PR) |
This was referenced Mar 8, 2021
This was referenced Mar 15, 2021
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.
What issue does this pull request resolve?
Adds some documentation to
JTDSchemaTypeWhat changes did you make?
See above
Is there anything that requires more attention while reviewing?
I'm not really sure how much detail you want. This seems like enough to me, but I'm definitely open. I'm not sure the usage of JTD in the readme is correct. Can you just import AJV or do you need to import AjvJTD? Or pass the
jtd: trueoption? Can you import nested directories in typescript, (e.g. doesimport AjvJTD from "ajv/dist/jtd";work?) ?I've only used the types in deno.Again, this is stacked, so ignore the first commit.