JSPM

ts-json-schema-generator

0.16.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 381004
  • Score
    100M100P100Q177141F

Generate JSON schema from your Typescript sources

Package Exports

  • ts-json-schema-generator
  • ts-json-schema-generator/dist/factory/formatter
  • ts-json-schema-generator/dist/factory/parser
  • ts-json-schema-generator/dist/factory/program
  • ts-json-schema-generator/dist/src/AnnotationsReader/BasicAnnotationsReader
  • ts-json-schema-generator/dist/src/AnnotationsReader/ExtendedAnnotationsReader
  • ts-json-schema-generator/dist/src/ChainNodeParser
  • ts-json-schema-generator/dist/src/CircularReferenceNodeParser
  • ts-json-schema-generator/dist/src/Config
  • ts-json-schema-generator/dist/src/Error/NoRootTypeError
  • ts-json-schema-generator/dist/src/ExposeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser
  • ts-json-schema-generator/dist/src/NodeParser/AnnotatedNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/AnyTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/ArrayNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/BooleanLiteralNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/BooleanTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/EnumNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/ExpressionWithTypeArgumentsNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/IndexedAccessTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/IntersectionNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/LiteralNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/MappedTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/NullLiteralNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/NumberLiteralNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/NumberTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/ObjectTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/ParenthesizedNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/StringLiteralNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/StringTypeNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/TupleNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/TypeAliasNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/TypeLiteralNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/TypeOperatorNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/TypeReferenceNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/TypeofNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/UnionNodeParser
  • ts-json-schema-generator/dist/src/NodeParser/VoidTypeNodeParser
  • ts-json-schema-generator/dist/src/TopRefNodeParser
  • ts-json-schema-generator/dist/src/Type/ArrayType
  • ts-json-schema-generator/dist/src/Type/DefinitionType
  • ts-json-schema-generator/dist/src/Type/TupleType

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ts-json-schema-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ts-json-schema-generator

Build Status npm dependencies npm version

Extended version of https://github.com/xiag-ag/typescript-to-json-schema.

Inspired by YousefED/typescript-json-schema. Here's the differences list:

  • this implementation does not use typeChecker.getTypeAtLocation() (so probably it keeps correct type aliases)
  • the following features are not supported yet:
    • class types
  • processing AST and formatting JSON schema have been split into two independent steps
  • not exported types, interfaces, enums are not exposed in the definitions section in the JSON schema

Usage

npm install --save ts-json-schema-generator
./node_modules/.bin/ts-json-schema-generator \
    --path 'my/project/**.*.ts' \
    --type 'My.Type.Full.Name' \
    --expose 'export' \
    --topRef 'yes' \
    --jsDoc 'extended'

Current state

  • interface types
  • enum types
  • union, tuple, type[] types
  • string, boolean, number types
  • "value", 123, true, false, null literals
  • type aliases
  • generics
  • typeof
  • @nullable annotations
  • @hide annotations for enum values and object properties

Debug

npm run debug -- test/programs/type-alias-single/main.ts --aliasRefs true MyString

And connect via the debugger protocol.

AST Explorer is amazing for developers of this tool!