Code coverage report for master/lib/jsdoc/env.js

Statements: 100% (1 / 1)      Branches: 100% (0 / 0)      Functions: 100% (0 / 0)      Lines: 100% (1 / 1)      Ignored: none     

All files » master/lib/jsdoc/ » env.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78            1                                                                                                                                              
/**
 * Data about the environment in which JSDoc is running, including the configuration settings that
 * were used to run JSDoc.
 *
 * @module jsdoc/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 absolute path to the base directory in which JSDoc is located. Set at startup.
     *
     * @private
     * @type {string}
     */
    dirname: null,
 
    /**
     * The user's working directory at the time when JSDoc started running.
     *
     * @private
     * @type {string}
     */
    pwd: null,
 
    /**
     * 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
    }
};