- Source:
Members
(static, constant) register :module:@citation-js/core.util.Register
Type:
- Source:
Methods
(static) add(name, formatter)
Add output plugin.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
module:@citation-js/core.plugins.output~formatterName | output format name |
formatter |
module:@citation-js/core.plugins.output~formatter | outputting function |
- Source:
Throws:
-
validation errors
- Type
- TypeError
(static) format(name, data, …options)
Call output plugin
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
module:@citation-js/core.plugins.output~formatterName | output format name |
|
data |
Array.<module:@citation-js/core~CSL> | all entries |
|
options |
* |
<repeatable> |
output options |
- Source:
(static) has(name) → {Boolean}
Check if output plugin exists.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
module:@citation-js/core.plugins.output~formatterName | output format name |
- Source:
Returns:
register has plugin
- Type
- Boolean
(static) list() → {Array.<String>}
List output plugins.
- Source:
Returns:
list of plugins
- Type
- Array.<String>
(static) remove(name)
Remove output plugin.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
module:@citation-js/core.plugins.output~formatterName | output format name |
- Source:
Type Definitions
formatter(data) → {String}
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Array.<module:@citation-js/core~InputData> |
- Source:
Returns:
output
- Type
- String
formatterName
Type:
- String
- Source: