Class Passage

A passage is a range of verses.

Hierarchy

Passage

Implements

PassageValue

Index

Constructors

Properties

Methods

isSameBook isSameChapter isSameVerse toString toValue extract extractAll parse

Constructors

constructor

new Passage(from: Reference, to: Reference): Passage
Create a new passage without validation.
Parameters
- from: Reference
  
  The first verse in the passage.
- to: Reference
  
  The last verse in the passage.
Returns Passage
- Defined in Passage.ts:26

Properties

`Readonly` from

from: Reference

The first verse in the passage.

`Readonly` to

The last verse in the passage.

Methods

`Private` isSameBook

isSameBook(): boolean
Returns boolean
- Defined in Passage.ts:108

`Private` isSameChapter

isSameChapter(): boolean
Returns boolean
- Defined in Passage.ts:112

`Private` isSameVerse

isSameVerse(): boolean
Returns boolean
- Defined in Passage.ts:116

toString

toString(): string
Convert the passage to a string.

Returns string
- Defined in Passage.ts:82

toValue

toValue(): PassageValue
The underlying value of the passage as a plain object.

Returns PassageValue
- Defined in Passage.ts:101

`Static` extract

extract(input: string): null | Passage
Extract the first passage from a string.

Returns
The first passage if one can be extracted, otherwise null.
Parameters
- input: string
  
  A string to attempt to extract a passage from.
Returns null | Passage
- Defined in Passage.ts:56

`Static` extractAll

extractAll(input: string): readonly Passage[]
Extract the passages from a string.

Returns
The passages if any can be extracted, otherwise an empty array.
Parameters
- input: string
  
  A string to attempt to extract a passages from.
Returns readonly Passage[]
- Defined in Passage.ts:70

`Static` parse

parse(input: string): Passage
Parse a passage from a string.

Throws
If the input cannot be parsed.
Parameters
- input: string
Returns Passage
- Defined in Passage.ts:41

Generated using TypeDoc