Comments (1)
Taken from the json-schema-to-ts README.md:
If you prefer to stick to them and can define your schemas in TS instead of JSON (importing JSONs
as const
is not available yet), thenjson-schema-to-ts
is made for you
Basically, json-schema-to-ts operates fully in TypeScript!! This is very very cool, since, this means you don't need a separate npx json-schema-to-typescript
build step to compile a .schema.json
file into a .ts
schema TypeScript file, then a typescript step. Instead, everything runs directly from TypeScript!!!
However, this has the following downsides, which makes json-schema-to-typescript
better in some cases:
json-schema-to-typescript
only needs to run once, whilejson-schema-to-ts
will need to run every time you (or any user of your library) runs TypeScripts, which is much much slower.- No TSDoc comments are generated in json-schema-to-ts, since it's pure TypeScript.
- Important: json-schema-to-ts only works with JSON Schema defined in a TypeScript file. Importing JSON schema from a
.json
file is not supported due to limitations in TypeScript.- This will hopefully be fixed in the future by TypeScript, please upvote microsoft/TypeScript#32063 if you're interested!
from json-schema-to-typescript.
Related Issues (20)
- Code generation for array of objects is wrong HOT 1
- Drop the `@minItems` / `@maxItems` JSDoc / TSDoc comments on tuple types
- ignoreMinAndMaxItems doesn't work in JSDoc HOT 1
- A schema with a field called "description" throws "TypeError: comment.split is not a function" HOT 1
- Support `prefixItems` for tuple validation HOT 2
- Feature Request: Generate Classes instead of interfaces HOT 2
- how to handle this error "This interface was referenced by ..." HOT 1
- `RangeError` for circular references to `oneOf` containing definition with the `$ref` HOT 3
- Crash for deprecated field missing description HOT 1
- A bit unclear about the purpose of `declareExternallyReferenced` and intention HOT 1
- Support ESM usage of module HOT 3
- Create `index.ts` when generating files from a directory HOT 1
- List on json-schema.org HOT 1
- Create Typscript schema with external references
- Convert empty object to Record<string,never> HOT 3
- Remove optional flag in case of `default` in schema. HOT 8
- `strictIndexSignatures` option is ignored for single pattern properties
- Package lists dev dependencies as dependencies HOT 4
- If `minProperties` is greater than or equal to the number of declared properties and `additionalProperties` is `false`, all properties should be required HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from json-schema-to-typescript.