Cite/index.js

  1. import * as log from './log'
  2. import * as options from './options'
  3. import * as set from './set'
  4. import * as sort from './sort'
  5. import * as get from './get'
  7. /**
  8.  * Citation.js input data, see {@tutorial input_types}
  9.  *
  10.  * @typedef InputData
  11.  * @tutorial input_types
  12.  */
  14. /**
  15.  * Citation.js {@tutorial input_options}
  16.  *
  17.  * @typedef {Object} Cite~InputOptions
  18.  * @tutorial input_options
  19.  *
  20.  * @property {Cite~OutputOptions} output
  21.  * @property {Number} maxChainLength
  22.  * @property {Boolean} generateGraph
  23.  * @property {Cite.parse~format} forceType
  24.  */
  26. /**
  27.  * Citation.js {@tutorial output_options}
  28.  *
  29.  * @typedef {Object} Cite~OutputOptions
  30.  * @tutorial output_options
  31.  *
  32.  * @property {String} format
  33.  * @property {String} type
  34.  * @property {String} style
  35.  * @property {String} lang
  36.  * @property {String|Cite~wrapper} prepend
  37.  * @property {String|Cite~wrapper} append
  38.  */
  40. /**
  41.  * @callback Cite~wrapper
  42.  * @param {CSL} data - Cite object
  43.  * @return {String} wrapping string
  44.  */
  46. /**
  47.  * [CSL](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html#csl-json-items) object
  48.  *
  49.  * @typedef {Object} CSL
  50.  */
  52. /**
  53.  * Create a `Cite` object with almost any kind of data, and manipulate it with its default methods.
  54.  *
  55.  * @access public
  56.  * @constructor Cite
  57.  *
  58.  * @param {Cite~InputData} data - Input data
  59.  * @param {Cite~InputOptions} [options={}] - Input options
  60.  */
  61. function Cite (data, options = {}) {
  62.   // Making it Scope-Safe
  63.   if (!(this instanceof Cite)) {
  64.     return new Cite(data, options)
  65.   }
  67.   /**
  68.    * The default options for the output. See [input options](../#cite.in.options)
  69.    *
  70.    * @access protected
  71.    * @memberof Cite#
  72.    *
  73.    * @property {Cite~InputOptions} options
  74.    */
  75.   this._options = options || {}
  77.   /**
  78.    * The saved-images-log
  79.    *
  80.    * @access protected
  81.    * @memberof Cite#
  82.    *
  83.    * @property {Array<Array<String>>} log
  84.    */
  85.   this.log = []
  87.   /**
  88.    * The parsed data
  89.    *
  90.    * @access protected
  91.    * @memberof Cite#
  92.    *
  93.    * @property {Array<CSL>} data
  94.    */
  95.   this.data = []
  97.   this.set(data, options)
  98.   this.options(options)
  99.   this.save()
  101.   return this
  102. }
  104. Object.assign(Cite.prototype, log, options, set, sort, get)
  106. Cite.prototype[Symbol.iterator] = function * () {
  107.   yield * this.data
  108. }
  110. export default Cite