input - Docs - Citation.js

Source:

parse/interface/index.js, line 1

Namespaces

util

Members

(static, constant) exports.add

See the relevant tutorial: Input Plugins

Source:

parse/interface/register.js, line 18

Tutorials:

Input Plugins

(protected, static, constant) exports.addDataParser

Source:

parse/interface/data.js, line 71

(static, constant) exports.addTypeParser

Source:

parse/interface/type.js, line 89

(static, constant) exports.data

Source:

parse/interface/data.js, line 28

(static, constant) exports.dataAsync

Source:

parse/interface/data.js, line 49

(static, constant) exports.has

Source:

parse/interface/register.js, line 70

(static, constant) exports.hasDataParser

Source:

parse/interface/data.js, line 88

(static, constant) exports.hasTypeParser

Source:

parse/interface/type.js, line 133

(static, constant) exports.list

Source:

parse/interface/register.js, line 77

(static, constant) exports.listDataParser

Source:

parse/interface/data.js, line 107

(static, constant) exports.listTypeParser

Source:

parse/interface/type.js, line 163

(static, constant) exports.remove

Source:

parse/interface/register.js, line 44

(static, constant) exports.removeDataParser

Source:

parse/interface/data.js, line 99

(static, constant) exports.removeTypeParser

Source:

parse/interface/type.js, line 141

(static, constant) exports.treeTypeParser

Source:

parse/interface/type.js, line 171

(static, constant) exports.type

Source:

parse/interface/type.js, line 65

(static, constant) exports.typeMatcher :RegExp

Validate and parse the format name

Source:

parse/interface/type.js, line 187

Type:

RegExp

Methods

(protected, static) chain(input, optionsopt) → {Array.<CSL>}

Parse input until success.

Source:

parse/interface/chain.js, line 7

Parameters:

Name	Type	Attributes	Description
`input`	`InputData`		input data
`options`	`Cite~InputOptions`	<optional>	options

Returns:

Type:: Array.<CSL>

The parsed input

(protected, static) chainAsync(input, optionsopt) → {Promise.<Array.<CSL>>}

Parse input until success. (async)

Source:

parse/interface/chain.js, line 63

Parameters:

Name	Type	Attributes	Description
`input`	`InputData`		input data
`options`	`Cite~InputOptions`	<optional>	options

Returns:

Type:: Promise.<Array.<CSL>>

The parsed input

(protected, static) chainLink(input) → {Array.<CSL>}

Parse input once.

Source:

parse/interface/chain.js, line 45

Parameters:

Name	Type	Description
`input`	`InputData`	input data

Returns:

Type:: Array.<CSL>

The parsed input

(protected, static) chainLinkAsync(input) → {Promise}

Parse input once. (async)

Source:

parse/interface/chain.js, line 101

Parameters:

Name	Type	Description
`input`	`InputData`	The input data

Returns:

Type:: Promise

The parsed input

Type Definitions

(async) asyncDataParser(input)

Source:

parse/interface/parser.js, line 27

Parameters:

Name	Type	Description
`input`	`InputData`

Returns:

parsed data

dataParser(input)

Source:

parse/interface/parser.js, line 21

Parameters:

Name	Type	Description
`input`	`InputData`

Returns:

parsed data

dataType

Source:

parse/interface/parser.js, line 46

Type:

String

elementConstraint

Source:

parse/interface/parser.js, line 80

Type:

Cite.plugins.input~format

format

Source:

parse/interface/parser.js, line 7

Type:

String

parsers

Properties:

Name	Type	Description
`parse`	`Cite.plugins.input~dataParser`
`parseAsync`	`Cite.plugins.input~asyncDataParser`
`parseType`	`Cite.plugins.input~typeParser`

Source:

parse/interface/parser.js, line 12

Type:

Object

predicate(input) → {Boolean}

Source:

parse/interface/parser.js, line 51

Parameters:

Name	Type	Description
`input`	`InputData`

Returns:

Type:: Boolean

pass

propertyConstraint

Properties:

Name	Type	Attributes	Default
`props`	`String` \| `Array.<String>`	<optional>	[]
`match`	`String`	<optional>	'every'
`value`	`Cite.plugins.input~valuePredicate`	<optional>

Source:

parse/interface/parser.js, line 66

Type:

Object

tokenList

Properties:

Name	Type	Attributes	Default	Description
`token`	`RegExp`			token pattern
`split`	`RegExp`	<optional>	/\s+/	token delimiter
`every`	`Boolean`	<optional>	true	match every token, or only some
`trim`	`Boolean`	<optional>	true	trim input whitespace before testing

Source:

parse/interface/parser.js, line 57

Type:

Object

typeParser

Properties:

Name	Type	Description
`dataType`	`Cite.plugins.input~dataType`
`predicate`	`Cite.plugins.input~predicate` \| `RegExp`
`tokenList`	`Cite.plugins.input~tokenList` \| `RegExp`
`propertyConstraint`	`Cite.plugins.input~propertyConstraint` \| `Array.<Cite.plugins.input~propertyConstraint>`
`elementConstraint`	`Cite.plugins.input~elementConstraint` \| `Array.<Cite.plugins.input~elementConstraint>`
`extends`	`Cite.plugins.input~format`

Source:

parse/interface/parser.js, line 34

Type:

Object

valuePredicate(value) → {Boolean}

Source:

parse/interface/parser.js, line 74

Parameters:

Name	Type	Description
`value`

Returns:

Type:: Boolean

pass