versification v0.0.24

versification

A library for parsing Paratext's vrs files.

Installation

npm install --save versification

Usage

The library has two main classes Versification and VerseRef. Versification parses a Paratext versification file (.vrs), which can be used to convert a VerseRef from one versification to another.

// Example usage, creating a VerseRef with Versification.

import Versification, { VerseRef } from 'versification';

const testVersification = `
# Versification  "English"
GEN 1:31 2:25 3:24 4:26 5:32 6:22
PSA 1:6 2:12 3:8
PSA 3:0-8 = PSA 3:1-9
`;


const myReducedSizeEnglishVersification = new Versification(testVersification);

const myVerseRef = VerseRef.parse('PSA 3:1', myReducedSizeEnglishVersification);

// Example changing a VerseRef versification.

import Versification, { VerseRef } from 'versification';

const testEnglishVersification = `
# Versification  "English"
GEN 1:31 2:25 3:24 4:26 5:32 6:22
PSA 1:6 2:12 3:8
PSA 3:0-8 = PSA 3:1-9
`;

const testOriginalVersification = `
# Versification  "Original"
GEN 1:31 2:25 3:24 4:26 5:32 6:22
PSA 1:6 2:12 3:9
`;

const engV = new Versification(testEnglishVersification);
const orgV = new Versification(testOriginalVersification);

const myEnglishVerseRef = VerseRef.parse('PSA 3:1', engV);

const myOriginalVerseRef = orgV.changeVersification(myEnglishVerseRef);

// Outputs 'PSA 3:2'
console.log(myOriginalVerseRef.toString()); 

Versification

VerseRef