jsdocs.js

  1. /** ****************************************************************************************************
  2.  * @file: jsdocs.js
  3.  * @project: template-api
  4.  * @author Nick Soggin <iSkore@users.noreply.github.com> on 09-Apr-2018
  5.  *******************************************************************************************************/
  6. 'use strict';
  8. /**
  9.  * @global
  10.  * @typedef {number} milliseconds
  11.  * @description
  12.  * A number assumed to be in milliseconds.<br/>
  13.  * Number is likely to be calculated against a Unix Epoch based timestamp or milliseconds since Jan 01 1970.<br/>
  14.  * When multiplied by <code>1e-3</code>, number should convert to seconds
  15.  * @mixin
  16.  */
  18. /**
  19.  * @global
  20.  * @typedef {number[]} hrtime
  21.  * @description
  22.  * A "tuple" assumed to be a result of calling for high resolution time <code>process.hrtime</code><br/>
  23.  * typically, a resulting <code>hrtime</code> should be the returned value of
  24.  * <code>process.hrtime( process.hrtime() );</code> where the inner <code>hrtime</code>
  25.  * is likely called before a function is run to calculate the time it took to run a process.
  26.  * tuple is assumed to be in nanoseconds
  27.  * @example
  28.  * [ 22727, 841838045 ]
  29.  * @mixin
  30.  */
  32. /**
  33.  * @global
  34.  * @typedef {number|string} radix
  35.  * @property {number} binary - specify 2 to return binary radix value
  36.  * @property {number} octal - specify 8 to return octal radix value
  37.  * @property {number} base10 - specify 10 to return base10 radix value
  38.  * @property {number} hexadecimal - specify 16 to return hexadecimal radix value
  39.  * @mixin
  40.  */
  42. /**
  43.  * @global
  44.  * @typedef {number|string} bytes
  45.  * @description
  46.  * The byte is a unit of digital information that most commonly consists of eight bits.
  47.  * Pertains to this application as a number or string expected to be a digital information measurement of "bytes"
  48.  *
  49.  * Recognized conversion units:
  50.  * <table class="params">
  51.  *     <thead><tr><th>(Unit)</th><th>[Standard Base 10]</th><th>[Digital Storage Unit 2ⁿ]</th></tr></thead>
  52.  *     <tbody>
  53.  *         <tr><td>(B)</td><td>Bytes</td><td>Bytes</td></tr>
  54.  *         <tr><td>(kB|KiB)</td><td>Kilobytes</td><td>Kibibytes</td></tr>
  55.  *         <tr><td>(mB|MiB)</td><td>Megabytes</td><td>Megibytes</td></tr>
  56.  *         <tr><td>(gB|GiB)</td><td>Gigabytes</td><td>Gigibytes</td></tr>
  57.  *         <tr><td>(tB|TiB)</td><td>Terabytes</td><td>Teribytes</td></tr>
  58.  *     </tbody>
  59.  * </table>
  60.  *
  61.  * @example
  62.  * 1 KB <-> 1000
  63.  * 1 KiB <-> 1024
  64.  * 1 Kilobytes <-> 1000
  65.  * 1 Kibibytes <-> 1024
  66.  * @mixin
  67.  */
  69. /**
  70.  * @global
  71.  * @typedef {string} uuid
  72.  * @description
  73.  * UUIDs (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDentifier).
  74.  * A UUID is 128 bits long, and can guarantee uniqueness across space and time.
  75.  * <a href="https://tools.ietf.org/html/rfc4122">RFC-4122</a>
  76.  *
  77.  * Assumed to be a hexadecimal string compliant with one of the following:
  78.  * <ul>
  79.  * <li><a href="https://tools.ietf.org/html/rfc4122#section-4.1.5">Time-Based UUID Version 1</a></li>
  80.  * <li><a href="https://tools.ietf.org/html/rfc4122#section-4.3">Name-Based UUID Version 3 & 5</a></li>
  81.  * <li><a href="https://tools.ietf.org/html/rfc4122#section-4.4">Truly-Random or Pseudo-Random Version 4</a></li>
  82.  * </ul>
  83.  * @example
  84.  * a0ac3f6e-510e-45d8-b199-07d63f23a011
  85.  * @mixin
  86.  */
  88. module.exports = {
  89. 	plugins: [
  90. 		'plugins/markdown'
  91. 	],
  92. 	markdown: {
  93. 		idInHeadings: true
  94. 	},
  95. 	recurseDepth: 20,
  96. 	source: {
  97. 		include: [
  98. 			'README.md',
  99. 			'./'
  100. 		],
  101. 		exclude: [
  102. 			'node_modules',
  103. 			'test',
  104. 			'docs'
  105. 		],
  106. 		includePattern: '.+\\.js(doc|x)?$',
  107. 		excludePattern: '(^|\\/|\\\\)_'
  108. 	},
  109. 	sourceType: 'module',
  110. 	tags: {
  111. 		allowUnknownTags: true,
  112. 		dictionaries: [
  113. 			'jsdoc',
  114. 			'closure'
  115. 		]
  116. 	},
  117. 	templates: {
  118. 		cleverLinks: true,
  119. 		monospaceLinks: true
  120. 	},
  121. 	opts: {
  122. 		encoding: 'utf8',
  123. 		destination: 'docs',
  124. 		recurse: true,
  125. 		template: './node_modules/postman-jsdoc-theme'
  126. 	}
  127. };