Namespace: input - Docs

Source:

core/src/plugins/input/index.js, line 1

Namespaces

util

Methods

(static) add(format, parsers)

See the relevant tutorial: Input Plugins

Parameters:

Name	Type	Description
`format`	module:@citation-js/core.plugins.input~format	input format name
`parsers`	module:@citation-js/core.plugins.input~parsers	parsers

Source:

core/src/plugins/input/register.js, line 11

Tutorials:

Input Plugins

(protected, static) addDataParser(format, parser, optionsopt)

Parameters:

Name Type Attributes Default Description

format module:@citation-js/core.plugins.input~format

parser module:@citation-js/core.plugins.input~parse | module:@citation-js/core.plugins.input~parseAsync

options

Object

{}

Properties

Name	Type	Attributes	Default	Description
`async`	Boolean	<optional>	false

Source:

core/src/plugins/input/data.js, line 86

(static) addTypeParser(format, typeParser)

Parameters:

Name	Type	Description
`format`	module:@citation-js/core.plugins.input~format
`typeParser`	module:@citation-js/core.plugins.input.util.TypeParser

Source:

core/src/plugins/input/type.js, line 83

(protected, static) chain(input, optionsopt) → {Array.<module:@citation-js/core~CSL>}

Parse input until success.

Parameters:

Name	Type	Attributes	Description
`input`	module:@citation-js/core~InputData		input data
`options`	module:@citation-js/core~InputOptions	<optional>	options

Source:

core/src/plugins/input/chain.js, line 114

Returns:

The parsed input

Type: Array.<module:@citation-js/core~CSL>

(protected, static) chainAsync(input, optionsopt) → {Promise.<Array.<module:@citation-js/core~CSL>>}

Parse input until success. (async)

Parameters:

Name	Type	Attributes	Description
`input`	module:@citation-js/core~InputData		input data
`options`	module:@citation-js/core~InputOptions	<optional>	options

Source:

core/src/plugins/input/chain.js, line 158

Returns:

The parsed input

Type: Promise.<Array.<module:@citation-js/core~CSL>>

(protected, static) chainLink(input) → {module:@citation-js/core~InputData}

Parse input once.

Parameters:

Name	Type	Description
`input`	module:@citation-js/core~InputData	input data

Source:

core/src/plugins/input/chain.js, line 140

Returns:

The parsed input

Type: module:@citation-js/core~InputData

(protected, static) chainLinkAsync(input) → {Promise.<module:@citation-js/core~InputData>}

Parse input once. (async)

Parameters:

Name	Type	Description
`input`	module:@citation-js/core~InputData	The input data

Source:

core/src/plugins/input/chain.js, line 180

Returns:

The parsed input

Type: Promise.<module:@citation-js/core~InputData>

(static) data(input, type) → {*|Null}

Parameters:

Name	Type	Description
`input`	module:@citation-js/core~InputData	input data
`type`	module:@citation-js/core.plugins.input~format	input type

Source:

core/src/plugins/input/data.js, line 42

Returns:

parsed data

Type

*
if no parser available

Type

Null

(static) dataAsync(input, type) → {Promise|Promise.<Null>}

Parameters:

Name	Type	Description
`input`	module:@citation-js/core~InputData	input data
`type`	module:@citation-js/core.plugins.input~format	input type

Source:

core/src/plugins/input/data.js, line 63

Returns:

parsed data

Type

Promise
if no parser available

Type

Promise.<Null>

(static) get(format) → {Object}

Parameters:

Name	Type	Description
`format`	module:@citation-js/core.plugins.input~format	input format name

Source:

core/src/plugins/input/register.js, line 47

Returns:

index

Type: Object

(static) has(format) → {Boolean}

Parameters:

Name	Type	Description
`format`	module:@citation-js/core.plugins.input~format	input format name

Source:

core/src/plugins/input/register.js, line 86

Returns:

input format is registered

Type: Boolean

(static) hasDataParser(type, asyncopt) → {Boolean}

Parameters:

Name	Type	Attributes	Default	Description
`type`	module:@citation-js/core.plugins.input~format
`async`	Boolean	<optional>	false	check only for async, or only sync

Source:

core/src/plugins/input/data.js, line 104

Returns:

parser exists

Type: Boolean

(static) hasTypeParser(type) → {Boolean}

Parameters:

Name	Type	Description
`type`	module:@citation-js/core.plugins.input~format

Source:

core/src/plugins/input/type.js, line 127

Returns:

type parser is registered

Type: Boolean

(static) list() → {Array.<module:@citation-js/core.plugins.input~format>}

Source:

core/src/plugins/input/register.js, line 97

Returns:

input format is registered

Type: Array.<module:@citation-js/core.plugins.input~format>

(static) listDataParser(asyncopt)

Parameters:

Name	Type	Attributes	Default	Description
`async`	Boolean	<optional>	false

Source:

core/src/plugins/input/data.js, line 132

(static) listTypeParser() → {Array.<module:@citation-js/core.plugins.input~format>}

Source:

core/src/plugins/input/type.js, line 163

Returns:

list of registered type parsers

Type: Array.<module:@citation-js/core.plugins.input~format>

(static) remove(format)

Parameters:

Name	Type	Description
`format`	module:@citation-js/core.plugins.input~format	input format name

Source:

core/src/plugins/input/register.js, line 59

(static) removeDataParser(type, asyncopt)

Parameters:

Name	Type	Attributes	Default	Description
`type`	module:@citation-js/core.plugins.input~format
`async`	Boolean	<optional>	false

Source:

core/src/plugins/input/data.js, line 120

(static) removeTypeParser(type)

Parameters:

Name	Type	Description
`type`	module:@citation-js/core.plugins.input~format

Source:

core/src/plugins/input/type.js, line 140

(static) treeTypeParser() → {Object}

Source:

core/src/plugins/input/type.js, line 174

Returns:

tree structure

Type: Object

(static) type(input) → {module:@citation-js/core.plugins.input~format}

Parameters:

Name	Type	Description
`input`	module:@citation-js/core~InputData

Source:

core/src/plugins/input/type.js, line 57

Returns:

type

Type: module:@citation-js/core.plugins.input~format

(static) typeMatcher() → {RegExp}

Validate and parse the format name

Source:

core/src/plugins/input/type.js, line 193

Returns:

Type: RegExp

Type Definitions

(async) asyncDataParser(input)

Parameters:

Name	Type	Description
`input`	InputData

Source:

core/src/plugins/input/types.jsdoc, line 21

Returns:

parsed data

dataParser(input)

Parameters:

Name	Type	Description
`input`	InputData

Source:

core/src/plugins/input/types.jsdoc, line 15

Returns:

parsed data

dataType

Type:

String

Source:

core/src/plugins/input/types.jsdoc, line 40

elementConstraint

Type:

module:@citation-js/core.plugins.input~format

Source:

core/src/plugins/input/types.jsdoc, line 74

format

Type:

String

Source:

core/src/plugins/input/types.jsdoc, line 1

parsers

Type:

Object

Properties:

Name	Type	Description
`parse`	module:@citation-js/core.plugins.input~dataParser
`parseAsync`	module:@citation-js/core.plugins.input~asyncDataParser
`parseType`	module:@citation-js/core.plugins.input~typeParser

Source:

core/src/plugins/input/types.jsdoc, line 6

predicate(input) → {Boolean}

Parameters:

Name	Type	Description
`input`	InputData

Source:

core/src/plugins/input/types.jsdoc, line 45

Returns:

pass

Type: Boolean

propertyConstraint

Type:

Object

Properties:

Name	Type	Attributes	Default
`props`	String \| Array.<String>	<optional>	[]
`match`	String	<optional>	'every'
`value`	module:@citation-js/core.plugins.input~valuePredicate	<optional>

Source:

core/src/plugins/input/types.jsdoc, line 60

tokenList

Type:

Object

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:

core/src/plugins/input/types.jsdoc, line 51

typeParser

Type:

Object

Properties:

Name	Type	Description
`dataType`	module:@citation-js/core.plugins.input~dataType
`predicate`	module:@citation-js/core.plugins.input~predicate \| RegExp
`tokenList`	module:@citation-js/core.plugins.input~tokenList \| RegExp
`propertyConstraint`	module:@citation-js/core.plugins.input~propertyConstraint \| Array.<module:@citation-js/core.plugins.input~propertyConstraint>
`elementConstraint`	module:@citation-js/core.plugins.input~elementConstraint \| Array.<module:@citation-js/core.plugins.input~elementConstraint>
`extends`	module:@citation-js/core.plugins.input~format

Source:

core/src/plugins/input/types.jsdoc, line 28

valuePredicate(value) → {Boolean}

Parameters:

Name	Type	Description
`value`

Source:

core/src/plugins/input/types.jsdoc, line 68

Returns:

pass

Type: Boolean