Skip to content

default(options: Options = {}): Function;

Notifications You must be signed in to change notification settings

TrialAndErrorOrg/reoff-parse-references

Repository files navigation

Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

API


default()

Signature

default(options: Options = {}): Function;

Parameters

Name Type
options Options

Returns

Function

Signature
(tree: Root, vfile: VFile): Promise<Root>;
Parameters
Name Type
tree Root
vfile VFile
Returns

Promise<Root>

Defined in: lib/reoff-parse-references.ts:5

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as

pnpm add reoff-parse-references
# or with yarn
[![npm version](https://badge.fury.io/js/reoff-parse-references.svg)](https://badge.fury.io/js/reoff-parse-references) [![npm downloads](https://img.shields.io/npm/dm/reoff-parse-references.svg)](https://www.npmjs.com/package/reoff-parse-references)
# yarn add reoff-parse-references
# or with npm
# npm install reoff-parse-references

reoff-parse-references

Plugin for reoff which tries to find a bibliography in the document and parse it using ooxast-util-parse-bib.

Running unit tests

Run nx test reoff-reoff-parse-references to execute the unit tests via Jest.