dtsgenerator

TypeScript d.ts file generator from JSON Schema file or Swagger spec file.


Table of Contents

- Install
- Usage
- Development
- ChangeLog
- License

Install

npm install -g dtsgenerator

- Releases

Usage

``
$ dtsgen --help

Usage: dtsgen [options]


Options:

-V, --version output the version number
--url input json schema from the url.
--stdin read stdin with other files or urls.
-o, --out output d.ts filename.
-p, --prefix set the prefix of interface name. default is nothing.
-H, --header set the string of type header.
-t, --target [version] set target TypeScript version. select from v2 or v1. default is v2.
-h, --help output usage information

Examples:

$ dtsgen --help
$ dtsgen --out types.d.ts schema/*/.schema.json
$ cat schema1.json | dtsgen --target v1
$ dtsgen -o swaggerSchema.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/schemas/v2.0/schema.json
$ dtsgen -o petstore.d.ts --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/petstore.yaml
`

Development

$3

Output debug message by debug library.

$ DEBUG=dtsgen dtsgen schema/news.json

$3

- The home of JSON Schema
- JSON Schema wiki for discussions on the next version of the draft
- Swagger Specification

ChangeLog

$3

- Support the integer enum type by #263. Thank you @heapx :*+1:

$3

- Bug fix about unresoled $refs by #253. Thank you @skuligowski :+1:

$3

- Bug fix about tuple type support by #244. Thank you @laurelnaiad :+1:

$3

- Support tuple type of #239, #241. Thank you @laurelnaiad :+1:

$3

- Fix the bug about allOf property of #226. Thank you @dawidgarus @philliphoff :+1:

$3

- Improve message in error log. Thank you @gasi :+1:

$3

- Add yaml format support! Thank you @jdthorpe :+1:

$3

- Remove gulp scripts

$3

- Switch from dtsm to @types

$3

- Add to support null type for TypeScript 2.0
- Add some input parameters

$3

- Update dependencies library

$3

- Fix crash bug #67

$3

- Update with some braking change

$3

- Minor update from v0.6.0

$3

- First stable version of dtsgenerator

License

dtsgenerator` is licensed under the MIT license.

Copyright © 2016, Hiroki Horiuchi