Note This repository is
citations-parse-text-cite
Small tool that parses a string of text containing APA style in text citations, e.g. Jones (2020), and returns a rudimentary AST with the thing parsed.
Not very efficient at all, just uses regex so don't run it on big pieces of text at once. To be used inside other more mature parsers in order to check whether what we are looking at is a citation. automatically generated from the main parser monorepo. Please submit any issues or pull requests there.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as
pnpm add parse-text-cite
# or with yarn
# yarn add parse-text-cite
# or with npm
# npm install parse-text-cite
API
parseTextCite()
Signature
parseTextCite(string: string, options?: Options): (string | Citation)[] | (string | Citation)[][];
Parameters
Name | Type |
---|---|
string |
string |
options? |
Options |
Returns
(string
| Citation
)[] | (string
| Citation
)[][]
Defined in: lib/parse-text-cite.ts:34
parser
Const
Parser
Defined in: lib/parse-text-cite.ts:32
Citation
Properties
citationId
string
Defined in: lib/parse-text-cite.ts:6
citationItems
Defined in: lib/parse-text-cite.ts:7
originalText?
string
Defined in: lib/parse-text-cite.ts:9
properties
Defined in: lib/parse-text-cite.ts:8
CitationItem
Properties
id
string
Defined in: lib/parse-text-cite.ts:19
infix?
string
Defined in: lib/parse-text-cite.ts:22
itemData
Data
Defined in: lib/parse-text-cite.ts:18
label?
string
Defined in: lib/parse-text-cite.ts:23
locator?
string
Defined in: lib/parse-text-cite.ts:24
prefix?
string
Defined in: lib/parse-text-cite.ts:20
suffix?
string
Defined in: lib/parse-text-cite.ts:21
Properties
Properties
mode?
string
Defined in: lib/parse-text-cite.ts:14
noteIndex
number
Defined in: lib/parse-text-cite.ts:13
License
GPL-3.0-or-later © Thomas F. K. Jorna