mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
62 lines
1.3 KiB
JavaScript
62 lines
1.3 KiB
JavaScript
/**
|
|
* Data about the environment in which JSDoc is running, including the configuration settings that
|
|
* were used to run JSDoc.
|
|
*
|
|
* @alias @jsdoc/core.env
|
|
*/
|
|
module.exports = {
|
|
/**
|
|
* The times at which JSDoc started and finished.
|
|
*
|
|
* @type {Object}
|
|
* @property {Date} start - The time at which JSDoc started running.
|
|
* @property {Date} finish - The time at which JSDoc finished running.
|
|
*/
|
|
run: {
|
|
start: new Date(),
|
|
finish: null,
|
|
},
|
|
|
|
/**
|
|
* The command-line arguments passed to JSDoc.
|
|
*
|
|
* @type {Array<*>}
|
|
*/
|
|
args: [],
|
|
|
|
/**
|
|
* The data parsed from JSDoc's configuration file.
|
|
*
|
|
* @type Object<string, *>
|
|
*/
|
|
conf: {},
|
|
|
|
/**
|
|
* The command-line arguments, parsed into a key/value hash.
|
|
*
|
|
* @type {Object}
|
|
* @example if (global.env.opts.help) { console.log('Helpful message.'); }
|
|
*/
|
|
opts: {},
|
|
|
|
/**
|
|
* The source files that JSDoc will parse.
|
|
*
|
|
* @type {Array<string>}
|
|
* @memberof env
|
|
*/
|
|
sourceFiles: [],
|
|
|
|
/**
|
|
* The JSDoc version number and revision date.
|
|
*
|
|
* @type {Object<string, string>}
|
|
* @property {string} number - The JSDoc version number.
|
|
* @property {string} revision - The JSDoc revision number, expressed as a UTC date string.
|
|
*/
|
|
version: {
|
|
number: null,
|
|
revision: null,
|
|
},
|
|
};
|