typedef

This project is under active development, and its API may change at any time without warning.

This is a utility for generating jsdoc @typedef comments based on an input JSON payload.

Install

npm install -g shawnrushefsky/typedef

Usage

typedef - a utility for generating jsdoc @typedef comments from json objects

Usage:
  typedef --name=<name> [options] [--extra <typedef>]...

Options:
  -h --help                         Show this screen
  -n --name <name>                  The name of the Type
  -f --file <file>                  Read from a file instead of STDIN
  -o --output <output>              Output to a file instead of STDOUT
  -d --description <description>    A description of the the type
  --json                            Output a JSON representation of the types
  -x --extra <typedef>              Accept a SubType Definition

Example:

  cat pull_request.json | typedef -n PullRequest >> types.js

Examples

./pr-types.sh is a script that demonstrates the use of typedef on a large complex object with several contained subtypes (A GitHub Pull Request Object.).