Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
jsdoc-api
Advanced tools
Readme
A programmatic interface for jsdoc3 with a few features:
> const jsdoc = require('jsdoc-api')
> jsdoc.explainSync({ source: '/** example doclet */ \n var example = true' })
[ { comment: '/** example doclet *∕',
meta:
{ range: [ 28, 42 ],
filename: 'nkrf18zlymohia4i29a0zkyt84obt9.js',
lineno: 2,
path: '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T',
code:
{ id: 'astnode100000002',
name: 'example',
type: 'Literal',
value: true } },
description: 'example doclet',
name: 'example',
longname: 'example',
kind: 'member',
scope: 'global' },
{ kind: 'package',
longname: 'package:undefined',
files: [ '/var/folders/74/tqh7thm11tq72d7sjty9qvdh0000gn/T/nkrf18zlymohia4i29a0zkyt84obt9.js' ] } ]
cache-point
Array.<object>
Promise
string
| Array.<string>
string
boolean
string
string
string
string
boolean
string
boolean
string
boolean
string
string
string
cache-point
The cache-point instance used when cache: true
is specified on .explain()
or .explainSync()
.
Kind: static property of jsdoc-api
Array.<object>
Returns jsdoc explain output.
Kind: static method of jsdoc-api
Prerequisite: Requires node v0.12 or above
Param | Type |
---|---|
[options] | JsdocOptions |
Promise
Returns a promise for the jsdoc explain output.
Kind: static method of jsdoc-api
Fulfil: object[]
- jsdoc explain output
Param | Type |
---|---|
[options] | JsdocOptions |
Render jsdoc documentation.
Kind: static method of jsdoc-api
Prerequisite: Requires node v0.12 or above
Param | Type |
---|---|
[options] | JsdocOptions |
Example
jsdoc.renderSync({ files: 'lib/*', destination: 'api-docs' })
The jsdoc options, common for all operations.
Kind: inner class of jsdoc-api
string
| Array.<string>
string
boolean
string
string
string
string
boolean
string
boolean
string
boolean
string
string
string
string
| Array.<string>
One or more filenames to process. Either this or source
must be supplied.
Kind: instance property of JsdocOptions
string
A string containing source code to process. Either this or files
must be supplied.
Kind: instance property of JsdocOptions
boolean
Set to true
to cache the output - future invocations with the same input will return immediately.
Kind: instance property of JsdocOptions
string
Only display symbols with the given access: "public", "protected", "private" or "undefined", or "all" for all access levels. Default: all except "private".
Kind: instance property of JsdocOptions
string
The path to the configuration file. Default: path/to/jsdoc/conf.json.
Kind: instance property of JsdocOptions
string
The path to the output folder. Use "console" to dump data to the console. Default: ./out/.
Kind: instance property of JsdocOptions
string
Assume this encoding when reading all source files. Default: utf8.
Kind: instance property of JsdocOptions
boolean
Display symbols marked with the @private tag. Equivalent to "--access all". Default: false.
Kind: instance property of JsdocOptions
string
The path to the project's package file. Default: path/to/sourcefiles/package.json
Kind: instance property of JsdocOptions
boolean
Treat errors as fatal errors, and treat warnings as errors. Default: false.
Kind: instance property of JsdocOptions
string
A query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true.
Kind: instance property of JsdocOptions
boolean
Recurse into subdirectories when scanning for source files and tutorials.
Kind: instance property of JsdocOptions
string
The path to the project's README file. Default: path/to/sourcefiles/README.md.
Kind: instance property of JsdocOptions
string
The path to the template to use. Default: path/to/jsdoc/templates/default.
Kind: instance property of JsdocOptions
string
Directory in which JSDoc should search for tutorials.
Kind: instance property of JsdocOptions
© 2015-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.
FAQs
A programmatic interface for jsdoc
The npm package jsdoc-api receives a total of 164,368 weekly downloads. As such, jsdoc-api popularity was classified as popular.
We found that jsdoc-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).