npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-schema-to-jsdoc

v1.1.1

Published

JSON Schema to JSDoc generator

Downloads

1,873

Readme

npm version Build Status

Known Vulnerabilities Total Alerts Code Quality: Javascript

JSON Schema to JSDoc

Useful when you already have a JSON Schema and want to document the types you want to validate. Works with subschema definitions.

Usage

const jsdoc = require('json-schema-to-jsdoc')

const schema = {
  "title": "Person",
  "type": "object",
  "properties": {
    "name": {"type": "string", "description": "A person's name"},
    "age": {"type": "integer", "description": "A person's age"}
  },
  "required": ["name"]
}

jsdoc(schema /* , optionsObject */)

Output

/**
 * @typedef {object} Person
 * @property {string} name A person's name
 * @property {integer} [age] A person's age
 */

Examples

hyphenatedDescriptions

jsdoc(schema, {
    hyphenatedDescriptions: true
})
/**
 * @typedef {object} Person
 * @property {string} name - A person's name
 * @property {integer} [age] - A person's age
 */

autoDescribe

jsdoc(schema, {
    autoDescribe: true
})
/**
 * Represents a Person object
 * @typedef {object} Person
 * @property {string} name A person's name
 * @property {integer} [age] A person's age
 */

types

jsdoc(schema, {
    types: {
      object: 'PlainObject'
    }
})
/**
 * @typedef {PlainObject} Person
 * @property {string} name A person's name
 * @property {integer} [age] A person's age
 */

formats

const schema = {
  title: 'Info',
  type: 'object',
  properties: {
    code: {
      type: 'string', format: 'html', description: 'The HTML source'
    }
  },
  required: ['code']
}

jsdoc(schema, {
    formats: {
      html: {
        string: 'HTML'
      }
    }
})
/**
 * @typedef {object} Info
 * @property {HTML} code The HTML source
 */

Options

addDescriptionLineBreak: boolean
Inserts an empty line when autoDescribe is false and the schema description is empty. Defaults to false.

autoDescribe: boolean
Adds a description ("Represents a/n [<title> ]<type>") when the schema has no description. Defaults to false.

capitalizeProperty: boolean
When propertyNameAsType is true, capitalizes the property-as-type, i.e., MyTitle in @property {MyTitle} myTitle. Defaults to false.

capitalizeTitle: boolean
If a schema title is present, capitalizes the schema's title in the output of @typedef {myType} title. Defaults to false.

defaultPropertyType: null | string
Used when no schema type is present. Defaults to "*".

  • string: If set to a string, that string will be used (e.g., "any", "JSON", "external:JSON"). Note that jsdoc recommends * for any, while TypeScript uses "any". If one defines one's own "JSON" type, one could use that to clarify that only JSON types are used.
  • null: Will avoid any type brackets or type being added.

descriptionPlaceholder: boolean
If false and there is no description for the object @property, this will avoid a hyphen or even a space for {description} within @property {name}{description}. Defaults to false.

hyphenatedDescriptions: boolean
Inserts a hyphen + space in the {description} portion of @property {name}{description} (will add a space, however, unless descriptionPlaceholder is false). Defaults to false.

ignore: string[]
Property names to ignore adding to output. Defaults to empty array.

indent: number
How many of indentChar to precede each line. Defaults to 0 (no indent). Note that a single space will be added in addition to the indent for every line of the document block after the first.

indentChar: string
Character to use when indent is set (e.g., a tab or space). Defaults to a space.

maxLength: number | boolean

  • number: Enforce a maximum length in @typedef and @property descriptions (taking into account indent/indentChar).
  • false: Prevent wrapping entirely. Defaults to false.

objectTagName: string
Tag name to use for objects. Defaults to typedef.

propertyNameAsType: boolean
Indicates that the property name (for objects) should be used as the type name (optionally capitalized with capitalizeProperty). Defaults to false.

types: null | {[schemaType: string]: string}
Used to determine output of curly-bracketed type content within @typedef {...}. If null no curly brackets or type content will be shown with the @typedef at all. If the schema type matches a property in the object map, and it maps to the empty string, an empty {} will result. Otherwise, if there is a type match, that string will be used as the curly bracketed type, or if there is no match, the schema's type will be used for the bracketed content. Defaults to an empty object map (will always just use the schema's type). This property may be used to change the likes of @typedef {object} to @typedef {PlainObject}.