Module: jsdoc/env

Data about the environment in which JSDoc is running, including the configuration settings that were used to run JSDoc.
Source:

Members

args :Array.<*>

The command-line arguments passed to JSDoc.
Type:
  • Array.<*>
Source:

conf :Object.<string, *>

The data parsed from JSDoc's configuration file.
Type:
  • Object.<string, *>
Source:

dirname :string

The absolute path to the base directory in which JSDoc is located. Set at startup.
Type:
  • string
Source:

opts :Object

The command-line arguments, parsed into a key/value hash.
Type:
  • Object
Source:
Example
if (global.env.opts.help) { console.log('Helpful message.'); }

pwd :string

The user's working directory at the time when JSDoc started running.
Type:
  • string
Source:

run :Object

The times at which JSDoc started and finished.
Type:
  • Object
Properties:
Name Type Description
start Date The time at which JSDoc started running.
finish Date The time at which JSDoc finished running.
Source:

version :Object.<string, string>

The JSDoc version number and revision date.
Type:
  • Object.<string, string>
Properties:
Name Type Description
number string The JSDoc version number.
revision string The JSDoc revision number, expressed as a UTC date string.
Source: