Tutorial: Cite Constructor

Cite Constructor

Create a new instance of Cite:

new Cite(data[, options])
  • data can be any of the input types listed in input_formats
  • options is an optional object with the input options listed in Input Options


const example = new Cite('10.5281/zenodo.1005176')

The optional second options argument is omitted here

You can access the parsed data like this:

> example.data
< [{title: 'Citation.js', DOI: '10.5281/zenodo.1005176', ...}]

You can also iterate over the data with a for...of loop:

const result = []
for (const entry of example) {

> result
< ['10.5281/zenodo.1005176']


You can also create a Cite instance asynchronously with a callback. This is recommended when parsing data that requires using APIs, like Wikidata IDs, Wikidata JSON, DOIs and URLs.

Cite.async('10.5281/zenodo.1005176', function (example) {
  example.data // [{DOI: '10.5281/zenodo.1005176', ...}]

If you omit the callback, Cite.async() returns a Promise:

const example = await Cite.async('10.5281/zenodo.1005176')

// or

Cite.async('10.5281/zenodo.1005176').then(function (example) {

You can use pass options to Cite.async() too, like this:

Cite.async('10.5281/zenodo.1005176', options, function (example) {
  example.data // [{DOI: '10.5281/zenodo.1005176', ...}]

// or

const example = await Cite.async('10.5281/zenodo.1005176', options)

// or

Cite.async('10.5281/zenodo.1005176', options).then(function (example) {