Skip to main content

Interface: IReferenceParser

Defined in: Services/ReferenceParser.ts:74

Interface for reference parsing. Implementations handle language-specific book name resolution and formatting. Latin-script languages can reuse ReferenceParser with different book name tables; languages with fundamentally different syntax should provide a full implementation.

Methods​

extractReferences()​

extractReferences(text): ParsedReference[]

Defined in: Services/ReferenceParser.ts:82

Parameters​

text​

string

Returns​

ParsedReference[]

format()​

format(ref): string

Defined in: Services/ReferenceParser.ts:81

Parameters​

ref​

ParsedReference

Returns​

string

getBookName()​

getBookName(bookNumber): string

Defined in: Services/ReferenceParser.ts:79

Parameters​

bookNumber​

number

Returns​

string

getBookNumber()​

getBookNumber(bookName): number | undefined

Defined in: Services/ReferenceParser.ts:77

Parameters​

bookName​

string

Returns​

number | undefined

getBookNumberFuzzy()​

getBookNumberFuzzy(bookName): { bookNumber: number; fuzzy: boolean; matchedName: string; } | undefined

Defined in: Services/ReferenceParser.ts:78

Parameters​

bookName​

string

Returns​

{ bookNumber: number; fuzzy: boolean; matchedName: string; } | undefined

isReference()​

isReference(text, options?): boolean

Defined in: Services/ReferenceParser.ts:75

Parameters​

text​

string

options?​

ReferenceParseOptions

Returns​

boolean

parse()​

parse(text, options?): ParsedReference

Defined in: Services/ReferenceParser.ts:76

Parameters​

text​

string

options?​

ReferenceParseOptions

Returns​

ParsedReference

scanText()​

scanText(text): ParsedReference & object[]

Defined in: Services/ReferenceParser.ts:83

Parameters​

text​

string

Returns​

ParsedReference & object[]

validate()​

validate(ref): string | undefined

Defined in: Services/ReferenceParser.ts:80

Parameters​

ref​

ParsedReference

Returns​

string | undefined