{"id":18961647,"url":"https://github.com/trialanderrororg/parse-text-cite","last_synced_at":"2026-04-01T15:30:19.100Z","repository":{"id":130692361,"uuid":"607888070","full_name":"TrialAndErrorOrg/parse-text-cite","owner":"TrialAndErrorOrg","description":"Small tool that parses a string of text containing APA style in text citations, e.g.","archived":false,"fork":false,"pushed_at":"2023-09-29T14:53:47.000Z","size":148,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T04:52:46.501Z","etag":null,"topics":["apa","bibliography","citations","parser","references"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TrialAndErrorOrg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-28T21:58:40.000Z","updated_at":"2023-09-08T18:41:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"965b5712-d9a1-4c4e-bce8-da2092907348","html_url":"https://github.com/TrialAndErrorOrg/parse-text-cite","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrialAndErrorOrg%2Fparse-text-cite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrialAndErrorOrg%2Fparse-text-cite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrialAndErrorOrg%2Fparse-text-cite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TrialAndErrorOrg%2Fparse-text-cite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TrialAndErrorOrg","download_url":"https://codeload.github.com/TrialAndErrorOrg/parse-text-cite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239958283,"owners_count":19724925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apa","bibliography","citations","parser","references"],"created_at":"2024-11-08T14:13:50.847Z","updated_at":"2026-04-01T15:30:19.058Z","avatar_url":"https://github.com/TrialAndErrorOrg.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e **Note**\n\u003e This repository is\n\n# citations-parse-text-cite\n\n[![npm version](https://badge.fury.io/js/parse-text-cite.svg)](https://badge.fury.io/js/parse-text-cite) [![npm downloads](https://img.shields.io/npm/dm/parse-text-cite.svg)](https://www.npmjs.com/package/parse-text-cite)\n\nSmall 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.\n\nNot 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.\nautomatically generated from the [main parser monorepo](https://github.com/TrialAndErrorOrg/parsers). Please submit any issues or pull requests there.\n\n## Install\n\nThis package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as\n\n```bash\npnpm add parse-text-cite\n# or with yarn\n# yarn add parse-text-cite\n# or with npm\n# npm install parse-text-cite\n```\n\n## API\n\n***\n\n### `parseTextCite()`\n\n#### Signature\n\n```ts\nparseTextCite(string: string, options?: Options): any[];\n```\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `string` | `string` |\n| `options?` | `Options` |\n\n#### Returns\n\n`any`[]\n\nDefined in:  [lib/parse-text-cite.ts:34](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L34)\n\n***\n\n### `parser`\n\n\u003e **`Const`** `Parser`\n\nDefined in:  [lib/parse-text-cite.ts:32](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L32)\n\n***\n\n### `Citation`\n\n#### Properties\n\n##### `citationId`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:6](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L6)\n\n##### `citationItems`\n\n\u003e [`CitationItem`](modules.md#citationitem)[]\n\nDefined in:  [lib/parse-text-cite.ts:7](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L7)\n\n##### `originalText?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:9](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L9)\n\n##### `properties`\n\n\u003e [`Properties`](modules.md#properties)\n\nDefined in:  [lib/parse-text-cite.ts:8](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L8)\n\n***\n\n### `CitationItem`\n\n#### Properties\n\n##### `id`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:19](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L19)\n\n##### `infix?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:22](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L22)\n\n##### `itemData`\n\n\u003e `Data`\n\nDefined in:  [lib/parse-text-cite.ts:18](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L18)\n\n##### `label?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:23](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L23)\n\n##### `locator?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:24](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L24)\n\n##### `prefix?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:20](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L20)\n\n##### `suffix?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:21](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L21)\n\n***\n\n### `Properties`\n\n#### Properties\n\n##### `mode?`\n\n\u003e `string`\n\nDefined in:  [lib/parse-text-cite.ts:14](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L14)\n\n##### `noteIndex`\n\n\u003e `number`\n\nDefined in:  [lib/parse-text-cite.ts:13](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/citations/parse-text-cite/src/lib/parse-text-cite.ts#L13)\n\n## License\n\n[GPL-3.0-or-later](LICENSE) © Thomas F. K. Jorna\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrialanderrororg%2Fparse-text-cite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrialanderrororg%2Fparse-text-cite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrialanderrororg%2Fparse-text-cite/lists"}