40 ldf/docs/classes/_calendar_liturgical_day_.liturgicalday.md
View file
@@ -46,7 +46,7 @@ like "Monday in Holy Week" or "The Eve of the Epiphany."

\+ **new LiturgicalDay**(`data`: Partial‹[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)›): *[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)*

*Defined in [calendar/liturgical-day.ts:225](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L225)*
*Defined in [calendar/liturgical-day.ts:225](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L225)*

**Parameters:**

@@ -62,7 +62,7 @@ Name | Type | Default |

• **collect**? : *undefined | string*

*Defined in [calendar/liturgical-day.ts:96](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L96)*
*Defined in [calendar/liturgical-day.ts:96](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L96)*

Optionally `slug` as an identifier for a collect only, but not readings
Used for e.g., Saturday evenings as first vespers of a Sunday
@@ -73,7 +73,7 @@ ___

• **color**? : *string | [LiturgicalColor](_calendar_liturgical_color_.liturgicalcolor.md)*

*Defined in [calendar/liturgical-day.ts:74](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L74)*
*Defined in [calendar/liturgical-day.ts:74](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L74)*

The [LiturgicalColor](_calendar_liturgical_color_.liturgicalcolor.md) used for the day

@@ -83,7 +83,7 @@ ___

• **date**: *string*

*Defined in [calendar/liturgical-day.ts:33](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L33)*
*Defined in [calendar/liturgical-day.ts:33](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L33)*

Dates are always stored as YYYY-MM-DD. No time or timezone information is helpful.
Date math can be done using a library like js-joda.
@@ -100,7 +100,7 @@ ___

• **evening**: *boolean* = false

*Defined in [calendar/liturgical-day.ts:47](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L47)*
*Defined in [calendar/liturgical-day.ts:47](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L47)*

True if this moment is the evening. Used to indicate the eve of feasts.

@@ -110,7 +110,7 @@ ___

• **holy_day_observed**? : *[HolyDay](_calendar_holy_day_.holyday.md)*

*Defined in [calendar/liturgical-day.ts:71](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L71)*
*Defined in [calendar/liturgical-day.ts:71](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L71)*

exists if one the listed `HolyDay`s is being observed

@@ -120,7 +120,7 @@ ___

• **holy_days**? : *[HolyDay](_calendar_holy_day_.holyday.md)[]*

*Defined in [calendar/liturgical-day.ts:68](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L68)*
*Defined in [calendar/liturgical-day.ts:68](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L68)*

An array of possible [HolyDay](_calendar_holy_day_.holyday.md)s that fall at this moment. It’s up to the consumer
to determine precedence.
@@ -131,7 +131,7 @@ ___

• **image**? : *undefined | string*

*Defined in [calendar/liturgical-day.ts:77](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L77)*
*Defined in [calendar/liturgical-day.ts:77](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L77)*

URL for an image of an icon for the day

@@ -141,7 +141,7 @@ ___

• **imageURL**? : *undefined | string*

*Defined in [calendar/liturgical-day.ts:80](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L80)*
*Defined in [calendar/liturgical-day.ts:80](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L80)*

Citation URL for an image

@@ -151,7 +151,7 @@ ___

• **kalendar**: *string*

*Defined in [calendar/liturgical-day.ts:36](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L36)*
*Defined in [calendar/liturgical-day.ts:36](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L36)*

Overarching calendar this is a part of

@@ -161,7 +161,7 @@ ___

• **octave**? : *string | undefined*

*Defined in [calendar/liturgical-day.ts:64](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L64)*
*Defined in [calendar/liturgical-day.ts:64](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L64)*

A machine-readable identifier day within the octave of which a day falls

@@ -171,7 +171,7 @@ ___

• **propers**? : *undefined | string*

*Defined in [calendar/liturgical-day.ts:91](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L91)*
*Defined in [calendar/liturgical-day.ts:91](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L91)*

Optionally `slug` as an identifier for readings and collects

@@ -189,7 +189,7 @@ ___

• **season**: *Seasons[number]*

*Defined in [calendar/liturgical-day.ts:61](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L61)*
*Defined in [calendar/liturgical-day.ts:61](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L61)*

A machine-readable identifier for the liturgical season

@@ -199,7 +199,7 @@ ___

• **slug**: *string*

*Defined in [calendar/liturgical-day.ts:44](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L44)*
*Defined in [calendar/liturgical-day.ts:44](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L44)*

An identifying slug that distinguishes this day from all others

@@ -213,7 +213,7 @@ ___

• **week**: *[LiturgicalWeek](_calendar_liturgical_week_.liturgicalweek.md)*

*Defined in [calendar/liturgical-day.ts:50](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L50)*
*Defined in [calendar/liturgical-day.ts:50](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L50)*

The [LiturgicalWeek](_calendar_liturgical_week_.liturgicalweek.md) during which this moment takes place.

@@ -223,7 +223,7 @@ ___

• **years**: *object*

*Defined in [calendar/liturgical-day.ts:58](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L58)*
*Defined in [calendar/liturgical-day.ts:58](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L58)*

Stores information about where a date falls in various lectionary cycles

@@ -241,7 +241,7 @@ Stores information about where a date falls in various lectionary cycles

▸ **addHolyDays**(`holydays`: [HolyDay](_calendar_holy_day_.holyday.md)[]): *[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)*

*Defined in [calendar/liturgical-day.ts:104](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L104)*
*Defined in [calendar/liturgical-day.ts:104](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L104)*

Given a LiturgicalDay, returns a new LiturgicalDay that includes the feasts passed

@@ -259,7 +259,7 @@ ___

▸ **getDate**(): *Date*

*Defined in [calendar/liturgical-day.ts:99](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L99)*
*Defined in [calendar/liturgical-day.ts:99](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L99)*

Returns a native Date from the day's date string

@@ -271,7 +271,7 @@ ___

▸ **isFeast**(): *boolean*

*Defined in [calendar/liturgical-day.ts:219](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L219)*
*Defined in [calendar/liturgical-day.ts:219](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L219)*

**Returns:** *boolean*

@@ -281,7 +281,7 @@ ___

▸ **observedDay**(`day`: [ObservedInterface](../interfaces/_calendar_liturgical_day_.observedinterface.md), `holydays`: [ObservedInterface](../interfaces/_calendar_liturgical_day_.observedinterface.md)[]): *[ObservedInterface](../interfaces/_calendar_liturgical_day_.observedinterface.md)*

*Defined in [calendar/liturgical-day.ts:169](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-day.ts#L169)*
*Defined in [calendar/liturgical-day.ts:169](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-day.ts#L169)*

Given a `LiturgicalDay` and a set of `HolyDay`s, it returns whichever option takes precedence

22 ldf/docs/classes/_calendar_liturgical_week_.liturgicalweek.md
View file
@@ -31,7 +31,7 @@

\+ **new LiturgicalWeek**(`data`: Partial‹[LiturgicalWeek](_calendar_liturgical_week_.liturgicalweek.md)›): *[LiturgicalWeek](_calendar_liturgical_week_.liturgicalweek.md)*

*Defined in [calendar/liturgical-week.ts:43](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L43)*
*Defined in [calendar/liturgical-week.ts:43](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L43)*

**Parameters:**

@@ -47,7 +47,7 @@ Name | Type | Default |

• **color**? : *[LiturgicalColor](_calendar_liturgical_color_.liturgicalcolor.md) | string*

*Defined in [calendar/liturgical-week.ts:37](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L37)*
*Defined in [calendar/liturgical-week.ts:37](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L37)*

The [LiturgicalColor](_calendar_liturgical_color_.liturgicalcolor.md) used for the week

@@ -57,7 +57,7 @@ ___

• **cycle**: *"Advent" | "Christmas" | "Epiphany" | "Easter"*

*Defined in [calendar/liturgical-week.ts:17](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L17)*
*Defined in [calendar/liturgical-week.ts:17](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L17)*

Seasonal cycle within which it falls

@@ -67,7 +67,7 @@ ___

• **kalendar**? : *undefined | string*

*Defined in [calendar/liturgical-week.ts:14](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L14)*
*Defined in [calendar/liturgical-week.ts:14](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L14)*

Overarching calendar this is a part of

@@ -77,7 +77,7 @@ ___

• **name**: *string*

*Defined in [calendar/liturgical-week.ts:29](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L29)*
*Defined in [calendar/liturgical-week.ts:29](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L29)*

A human-readable name for the week, in English

@@ -87,7 +87,7 @@ ___

• **omit_the**? : *undefined | false | true* = false

*Defined in [calendar/liturgical-week.ts:34](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L34)*
*Defined in [calendar/liturgical-week.ts:34](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L34)*

Used for English-language formatting, generally when "week" name is the proper name of a Sunday.

@@ -100,7 +100,7 @@ ___

• **proper**? : *undefined | number*

*Defined in [calendar/liturgical-week.ts:40](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L40)*
*Defined in [calendar/liturgical-week.ts:40](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L40)*

The proper (i.e., for weeks after Pentecost)

@@ -110,7 +110,7 @@ ___

• **propers**? : *undefined | string*

*Defined in [calendar/liturgical-week.ts:43](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L43)*
*Defined in [calendar/liturgical-week.ts:43](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L43)*

Optionally `slug` as an identifier for readings and collects

@@ -120,7 +120,7 @@ ___

• **season**: *Seasons[number]*

*Defined in [calendar/liturgical-week.ts:26](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L26)*
*Defined in [calendar/liturgical-week.ts:26](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L26)*

A machine-readable identifier for the liturgical season

@@ -130,7 +130,7 @@ ___

• **slug**: *string*

*Defined in [calendar/liturgical-week.ts:11](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L11)*
*Defined in [calendar/liturgical-week.ts:11](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L11)*

An identifying slug that distinguishes this week from all others

@@ -144,7 +144,7 @@ ___

• **week**: *number*

*Defined in [calendar/liturgical-week.ts:23](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/liturgical-week.ts#L23)*
*Defined in [calendar/liturgical-week.ts:23](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/liturgical-week.ts#L23)*

Index within the seasonal cycle

10 ldf/docs/classes/_calendar_proper_liturgy_.properliturgy.md
View file
@@ -25,7 +25,7 @@ e.g., Ash Wednesday,

• **label**: *string*

*Defined in [calendar/proper-liturgy.ts:16](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/proper-liturgy.ts#L16)*
*Defined in [calendar/proper-liturgy.ts:16](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/proper-liturgy.ts#L16)*

A human-readable name; either the name of the whole liturgy, or a label for a piece.

@@ -38,7 +38,7 @@ ___

• **language**: *string*

*Defined in [calendar/proper-liturgy.ts:21](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/proper-liturgy.ts#L21)*
*Defined in [calendar/proper-liturgy.ts:21](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/proper-liturgy.ts#L21)*

Language code (typically an ISO 639-1 two-letter code)

@@ -51,7 +51,7 @@ ___

• **liturgy**: *string*

*Defined in [calendar/proper-liturgy.ts:11](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/proper-liturgy.ts#L11)*
*Defined in [calendar/proper-liturgy.ts:11](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/proper-liturgy.ts#L11)*

Chooses a particular liturgy

@@ -61,7 +61,7 @@ ___

• **preference**: *string*

*Defined in [calendar/proper-liturgy.ts:8](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/proper-liturgy.ts#L8)*
*Defined in [calendar/proper-liturgy.ts:8](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/proper-liturgy.ts#L8)*

Set a particular preference to the value `true` when loading liturgy

@@ -71,6 +71,6 @@ ___

• **slug**: *string*

*Defined in [calendar/proper-liturgy.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/calendar/proper-liturgy.ts#L5)*
*Defined in [calendar/proper-liturgy.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/calendar/proper-liturgy.ts#L5)*

Matches to slug of a LiturgicalDay
16 ldf/docs/classes/_canticle_table_canticle_table_.canticletableentry.md
View file
@@ -25,60 +25,60 @@

• **day**: *string*

*Defined in [canticle-table/canticle-table.ts:9](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L9)*
*Defined in [canticle-table/canticle-table.ts:9](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L9)*

___

### evening

• **evening**: *boolean*

*Defined in [canticle-table/canticle-table.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L5)*
*Defined in [canticle-table/canticle-table.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L5)*

___

### nth

• **nth**: *number*

*Defined in [canticle-table/canticle-table.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L6)*
*Defined in [canticle-table/canticle-table.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L6)*

___

### season

• **season**: *string*

*Defined in [canticle-table/canticle-table.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L7)*
*Defined in [canticle-table/canticle-table.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L7)*

___

### slug

• **slug**: *string*

*Defined in [canticle-table/canticle-table.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L3)*
*Defined in [canticle-table/canticle-table.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L3)*

___

### table

• **table**: *string*

*Defined in [canticle-table/canticle-table.ts:2](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L2)*
*Defined in [canticle-table/canticle-table.ts:2](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L2)*

___

### week

• **week**: *string*

*Defined in [canticle-table/canticle-table.ts:8](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L8)*
*Defined in [canticle-table/canticle-table.ts:8](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L8)*

___

### weekday

• **weekday**: *string*

*Defined in [canticle-table/canticle-table.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/canticle-table/canticle-table.ts#L4)*
*Defined in [canticle-table/canticle-table.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/canticle-table/canticle-table.ts#L4)*
10 ldf/docs/classes/_citation_citation_.citation.md
View file
@@ -28,7 +28,7 @@

\+ **new Citation**(`data`: Partial‹[Citation](_citation_citation_.citation.md)›): *[Citation](_citation_citation_.citation.md)*

*Defined in [citation/citation.ts:16](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/citation.ts#L16)*
*Defined in [citation/citation.ts:16](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/citation.ts#L16)*

**Parameters:**

@@ -44,7 +44,7 @@ Name | Type | Default |

• **api**: *string* = "https://www.venite.app/api"

*Defined in [citation/citation.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/citation.ts#L3)*
*Defined in [citation/citation.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/citation.ts#L3)*

The URL (as a string) for the API from which more information about the source can be found

@@ -54,7 +54,7 @@ ___

• **citation**: *string*

*Defined in [citation/citation.ts:11](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/citation.ts#L11)*
*Defined in [citation/citation.ts:11](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/citation.ts#L11)*

Citation within that source

@@ -67,7 +67,7 @@ ___

• **source**: *string*

*Defined in [citation/citation.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/citation.ts#L6)*
*Defined in [citation/citation.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/citation.ts#L6)*

A machine-readable unique identifying slug for the source

@@ -77,7 +77,7 @@ A machine-readable unique identifying slug for the source

▸ **toString**(`suppressSource`: boolean): *string*

*Defined in [citation/citation.ts:14](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/citation.ts#L14)*
*Defined in [citation/citation.ts:14](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/citation.ts#L14)*

Provides a human-readable string form of the citation

10 ldf/docs/classes/_citation_selectable_citation_.selectablecitation.md
View file
@@ -22,36 +22,36 @@

• **book**? : *undefined | string*

*Defined in [citation/selectable-citation.ts:2](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/selectable-citation.ts#L2)*
*Defined in [citation/selectable-citation.ts:2](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/selectable-citation.ts#L2)*

___

### `Optional` chapter

• **chapter**? : *undefined | string*

*Defined in [citation/selectable-citation.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/selectable-citation.ts#L3)*
*Defined in [citation/selectable-citation.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/selectable-citation.ts#L3)*

___

### `Optional` label

• **label**? : *undefined | string*

*Defined in [citation/selectable-citation.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/selectable-citation.ts#L5)*
*Defined in [citation/selectable-citation.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/selectable-citation.ts#L5)*

___

### `Optional` string

• **string**? : *undefined | string*

*Defined in [citation/selectable-citation.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/selectable-citation.ts#L6)*
*Defined in [citation/selectable-citation.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/selectable-citation.ts#L6)*

___

### `Optional` verse

• **verse**? : *undefined | string*

*Defined in [citation/selectable-citation.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/selectable-citation.ts#L4)*
*Defined in [citation/selectable-citation.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/selectable-citation.ts#L4)*
14 ldf/docs/classes/_citation_source_.source.md
View file
@@ -24,31 +24,31 @@

• **author**? : *undefined | string*

*Defined in [citation/source.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L7)*
*Defined in [citation/source.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L7)*

___

### `Optional` city

• **city**? : *undefined | string*

*Defined in [citation/source.ts:9](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L9)*
*Defined in [citation/source.ts:9](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L9)*

___

### `Optional` date

• **date**? : *undefined | string*

*Defined in [citation/source.ts:10](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L10)*
*Defined in [citation/source.ts:10](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L10)*

___

### `Optional` license

• **license**? : *undefined | string*

*Defined in [citation/source.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L6)*
*Defined in [citation/source.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L6)*

Copyright metadata

@@ -58,15 +58,15 @@ ___

• **publisher**? : *undefined | string*

*Defined in [citation/source.ts:8](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L8)*
*Defined in [citation/source.ts:8](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L8)*

___

### slug

• **slug**: *string*

*Defined in [citation/source.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L3)*
*Defined in [citation/source.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L3)*

A machine-readable unique identifying slug for the source

@@ -76,4 +76,4 @@ ___

• **url**? : *undefined | string*

*Defined in [citation/source.ts:11](https://github.com/gbj/venite/blob/3c92166c/ldf/src/citation/source.ts#L11)*
*Defined in [citation/source.ts:11](https://github.com/gbj/venite/blob/8e444889/ldf/src/citation/source.ts#L11)*
22 ldf/docs/classes/_condition_.condition.md
View file
@@ -34,7 +34,7 @@

\+ **new Condition**(`data`: Partial‹[Condition](_condition_.condition.md)›): *[Condition](_condition_.condition.md)*

*Defined in [condition.ts:168](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L168)*
*Defined in [condition.ts:168](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L168)*

**Parameters:**

@@ -50,71 +50,71 @@ Name | Type | Default |

• **date**? : *undefined | object*

*Defined in [condition.ts:37](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L37)*
*Defined in [condition.ts:37](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L37)*

___

### `Optional` day

• **day**? : *undefined | object*

*Defined in [condition.ts:9](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L9)*
*Defined in [condition.ts:9](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L9)*

___

### `Optional` day_of_month

• **day_of_month**? : *undefined | object*

*Defined in [condition.ts:45](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L45)*
*Defined in [condition.ts:45](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L45)*

___

### `Optional` feastDay

• **feastDay**? : *undefined | false | true*

*Defined in [condition.ts:21](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L21)*
*Defined in [condition.ts:21](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L21)*

___

### `Optional` preference

• **preference**? : *undefined | object*

*Defined in [condition.ts:51](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L51)*
*Defined in [condition.ts:51](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L51)*

___

### `Optional` season

• **season**? : *undefined | object*

*Defined in [condition.ts:15](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L15)*
*Defined in [condition.ts:15](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L15)*

___

### `Optional` week

• **week**? : *undefined | object*

*Defined in [condition.ts:31](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L31)*
*Defined in [condition.ts:31](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L31)*

___

### `Optional` weekday

• **weekday**? : *undefined | object*

*Defined in [condition.ts:25](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L25)*
*Defined in [condition.ts:25](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L25)*

## Methods

### exceptOnlyFactory

▸ **exceptOnlyFactory**(`property`: "day" | "season" | "weekday" | "week", `include`: string, `evaluatedConditions`: boolean[]): *void*

*Defined in [condition.ts:157](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L157)*
*Defined in [condition.ts:157](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L157)*

**Parameters:**

@@ -132,7 +132,7 @@ ___

▸ **include**(`day`: [LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md), `prefs`: [ClientPreferences](_liturgy_client_preferences_.clientpreferences.md)): *boolean*

*Defined in [condition.ts:58](https://github.com/gbj/venite/blob/3c92166c/ldf/src/condition.ts#L58)*
*Defined in [condition.ts:58](https://github.com/gbj/venite/blob/8e444889/ldf/src/condition.ts#L58)*

Given a liturgical day and a set of preferences, evaluates whether the condition should be included

32 ldf/docs/classes/_display_settings_.displaysettings.md
View file
@@ -36,7 +36,7 @@

\+ **new DisplaySettings**(`dropcaps`: "decorated" | "plain" | "none", `response`: "bold" | "italics", `repeatAntiphon`: "bracket" | "repeat" | "none", `fontscale`: "s" | "m" | "l" | "xl" | "xxl", `font`: "garamond" | "gill-sans", `voiceChoice`: string, `voiceRate`: number, `voiceBackground`: "silence" | "seashore" | "garden" | "night" | "silence-short", `voiceBackgroundVolume`: number, `psalmVerses`: boolean, `bibleVerses`: boolean, `meditationBell`: "silence" | "singing-bowl", `darkmode`: "auto" | "dark" | "light" | "ecru", `bolded`: "both" | "unison" | "response" | "none", `psalmPause`: number): *[DisplaySettings](_display_settings_.displaysettings.md)*

*Defined in [display-settings.ts:1](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L1)*
*Defined in [display-settings.ts:1](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L1)*

**Parameters:**

@@ -66,116 +66,116 @@ Name | Type | Default |

• **bibleVerses**: *boolean*

*Defined in [display-settings.ts:13](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L13)*
*Defined in [display-settings.ts:13](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L13)*

___

### bolded

• **bolded**: *"both" | "unison" | "response" | "none"*

*Defined in [display-settings.ts:16](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L16)*
*Defined in [display-settings.ts:16](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L16)*

___

### darkmode

• **darkmode**: *"auto" | "dark" | "light" | "ecru"*

*Defined in [display-settings.ts:15](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L15)*
*Defined in [display-settings.ts:15](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L15)*

___

### dropcaps

• **dropcaps**: *"decorated" | "plain" | "none"*

*Defined in [display-settings.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L3)*
*Defined in [display-settings.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L3)*

___

### font

• **font**: *"garamond" | "gill-sans"*

*Defined in [display-settings.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L7)*
*Defined in [display-settings.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L7)*

___

### fontscale

• **fontscale**: *"s" | "m" | "l" | "xl" | "xxl"*

*Defined in [display-settings.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L6)*
*Defined in [display-settings.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L6)*

___

### meditationBell

• **meditationBell**: *"silence" | "singing-bowl"*

*Defined in [display-settings.ts:14](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L14)*
*Defined in [display-settings.ts:14](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L14)*

___

### psalmPause

• **psalmPause**: *number*

*Defined in [display-settings.ts:17](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L17)*
*Defined in [display-settings.ts:17](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L17)*

___

### psalmVerses

• **psalmVerses**: *boolean*

*Defined in [display-settings.ts:12](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L12)*
*Defined in [display-settings.ts:12](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L12)*

___

### repeatAntiphon

• **repeatAntiphon**: *"bracket" | "repeat" | "none"*

*Defined in [display-settings.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L5)*
*Defined in [display-settings.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L5)*

___

### response

• **response**: *"bold" | "italics"*

*Defined in [display-settings.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L4)*
*Defined in [display-settings.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L4)*

___

### voiceBackground

• **voiceBackground**: *"silence" | "seashore" | "garden" | "night" | "silence-short"*

*Defined in [display-settings.ts:10](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L10)*
*Defined in [display-settings.ts:10](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L10)*

___

### voiceBackgroundVolume

• **voiceBackgroundVolume**: *number*

*Defined in [display-settings.ts:11](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L11)*
*Defined in [display-settings.ts:11](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L11)*

___

### voiceChoice

• **voiceChoice**: *string*

*Defined in [display-settings.ts:8](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L8)*
*Defined in [display-settings.ts:8](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L8)*

___

### voiceRate

• **voiceRate**: *number*

*Defined in [display-settings.ts:9](https://github.com/gbj/venite/blob/3c92166c/ldf/src/display-settings.ts#L9)*
*Defined in [display-settings.ts:9](https://github.com/gbj/venite/blob/8e444889/ldf/src/display-settings.ts#L9)*
10 ldf/docs/classes/_editing_change_.change.md
View file
@@ -28,7 +28,7 @@

\+ **new Change**(`data`: Partial‹[Change](_editing_change_.change.md)›): *[Change](_editing_change_.change.md)*

*Defined in [editing/change.ts:20](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L20)*
*Defined in [editing/change.ts:20](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L20)*

**Parameters:**

@@ -44,30 +44,30 @@ Name | Type | Default |

• **op**: *[Operation](_editing_change_.operation.md)[]*

*Defined in [editing/change.ts:12](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L12)*
*Defined in [editing/change.ts:12](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L12)*

___

### path

• **path**: *string*

*Defined in [editing/change.ts:11](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L11)*
*Defined in [editing/change.ts:11](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L11)*

___

### `Optional` user

• **user**? : *undefined | string*

*Defined in [editing/change.ts:10](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L10)*
*Defined in [editing/change.ts:10](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L10)*

## Methods

### fullyPathedOp

▸ **fullyPathedOp**(): *[Operation](_editing_change_.operation.md)[]*

*Defined in [editing/change.ts:14](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L14)*
*Defined in [editing/change.ts:14](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L14)*

**Returns:** *[Operation](_editing_change_.operation.md)[]*
10 ldf/docs/classes/_editing_change_.operation.md
View file
@@ -22,36 +22,36 @@

• **index**? : *number | string*

*Defined in [editing/change.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L4)*
*Defined in [editing/change.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L4)*

___

### `Optional` oldValue

• **oldValue**? : *any*

*Defined in [editing/change.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L5)*
*Defined in [editing/change.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L5)*

___

### `Optional` p

• **p**? : *(undefined | string | number)[]*

*Defined in [editing/change.ts:2](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L2)*
*Defined in [editing/change.ts:2](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L2)*

___

### type

• **type**: *"insertAt" | "deleteAt" | "set" | "delete" | "edit" | "move"*

*Defined in [editing/change.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L3)*
*Defined in [editing/change.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L3)*

___

### `Optional` value

• **value**? : *any*

*Defined in [editing/change.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change.ts#L6)*
*Defined in [editing/change.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change.ts#L6)*
8 ldf/docs/classes/_editing_change_message_.changemessage.md
View file
@@ -21,28 +21,28 @@

• **change**: *[Change](_editing_change_.change.md)*

*Defined in [editing/change-message.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change-message.ts#L7)*
*Defined in [editing/change-message.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change-message.ts#L7)*

___

### docId

• **docId**: *string*

*Defined in [editing/change-message.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change-message.ts#L4)*
*Defined in [editing/change-message.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change-message.ts#L4)*

___

### lastRevision

• **lastRevision**: *number*

*Defined in [editing/change-message.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change-message.ts#L6)*
*Defined in [editing/change-message.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change-message.ts#L6)*

___

### `Optional` username

• **username**? : *undefined | string*

*Defined in [editing/change-message.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/change-message.ts#L5)*
*Defined in [editing/change-message.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/change-message.ts#L5)*
12 ldf/docs/classes/_editing_cursor_.cursor.md
View file
@@ -26,7 +26,7 @@

\+ **new Cursor**(`path`: string, `start`: number, `end`: number, `element`: HTMLTextAreaElement | HTMLInputElement): *[Cursor](_editing_cursor_.cursor.md)*

*Defined in [editing/cursor.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor.ts#L6)*
*Defined in [editing/cursor.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor.ts#L6)*

**Parameters:**

@@ -45,36 +45,36 @@ Name | Type |

• **element**: *HTMLTextAreaElement | HTMLInputElement*

*Defined in [editing/cursor.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor.ts#L6)*
*Defined in [editing/cursor.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor.ts#L6)*

___

### end

• **end**: *number*

*Defined in [editing/cursor.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor.ts#L5)*
*Defined in [editing/cursor.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor.ts#L5)*

___

### path

• **path**: *string*

*Defined in [editing/cursor.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor.ts#L3)*
*Defined in [editing/cursor.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor.ts#L3)*

___

### start

• **start**: *number*

*Defined in [editing/cursor.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor.ts#L4)*
*Defined in [editing/cursor.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor.ts#L4)*

___

### `Optional` user

• **user**? : *undefined | string*

*Defined in [editing/cursor.ts:2](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor.ts#L2)*
*Defined in [editing/cursor.ts:2](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor.ts#L2)*
8 ldf/docs/classes/_editing_cursor_message_.cursormessage.md
View file
@@ -21,28 +21,28 @@

• **cursor**: *[Cursor](_editing_cursor_.cursor.md)*

*Defined in [editing/cursor-message.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor-message.ts#L7)*
*Defined in [editing/cursor-message.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor-message.ts#L7)*

___

### docId

• **docId**: *string*

*Defined in [editing/cursor-message.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor-message.ts#L4)*
*Defined in [editing/cursor-message.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor-message.ts#L4)*

___

### lastRevision

• **lastRevision**: *number*

*Defined in [editing/cursor-message.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor-message.ts#L6)*
*Defined in [editing/cursor-message.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor-message.ts#L6)*

___

### `Optional` username

• **username**? : *undefined | string*

*Defined in [editing/cursor-message.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/editing/cursor-message.ts#L5)*
*Defined in [editing/cursor-message.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/editing/cursor-message.ts#L5)*
62 ldf/docs/classes/_heading_.heading.md
View file
@@ -58,7 +58,7 @@

*Overrides [Liturgy](_liturgy_liturgy_.liturgy.md).[constructor](_liturgy_liturgy_.liturgy.md#constructor)*

*Defined in [heading.ts:37](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L37)*
*Defined in [heading.ts:37](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L37)*

**Parameters:**

@@ -76,7 +76,7 @@ Name | Type | Default |

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[api](_responsive_prayer_.responsiveprayer.md#optional-api)*

*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L103)*
*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L103)*

The URL (as a string) for the API that provided the document, or against which it can be compiled.

@@ -88,7 +88,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[category](_responsive_prayer_.responsiveprayer.md#category)*

*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L93)*
*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L93)*

Category tags allow searches for things like 'Psalm', 'Canticle', 'Confession', 'Eucharist'.

@@ -100,7 +100,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[citation](_responsive_prayer_.responsiveprayer.md#optional-citation)*

*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L144)*
*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L144)*

Biblical or other citation for the document.

@@ -115,7 +115,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[condition](_responsive_prayer_.responsiveprayer.md#condition)*

*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L96)*
*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L96)*

An array of `Conditions`s determining whether the document should be displayed, given its day.

@@ -133,7 +133,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[date_created](_responsive_prayer_.responsiveprayer.md#optional-date_created)*

*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L72)*
*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L72)*

Timestamps for document creation and modification

@@ -145,7 +145,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[date_modified](_responsive_prayer_.responsiveprayer.md#optional-date_modified)*

*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L73)*
*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L73)*

___

@@ -155,7 +155,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[day](_responsive_prayer_.responsiveprayer.md#optional-day)*

*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L160)*
*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L160)*

Optional: The liturgical day against which to compile the value, or against which a liturgy has been compiled.
[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)
@@ -168,7 +168,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[display_format](_responsive_prayer_.responsiveprayer.md#optional-display_format)*

*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L87)*
*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L87)*

Specify how the text should be displayed
Unison: the entire text is a congregational response
@@ -184,7 +184,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[display_settings](_responsive_prayer_.responsiveprayer.md#optional-display_settings)*

*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L90)*
*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L90)*

Display Settings (font, etc.) to be applied to the document as a whole

@@ -196,7 +196,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[hidden](_responsive_prayer_.responsiveprayer.md#hidden)*

*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L171)*
*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L171)*

Marks a document hidden, so it will not display but will not be deleted
Typically used to a hide a subdocument within a larger liturgy without removing it entirely from the structure,
@@ -210,7 +210,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[id](_responsive_prayer_.responsiveprayer.md#optional-id)*

*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L69)*
*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L69)*

If provided from a database, `id` is unique identifier/DB primary key

@@ -222,7 +222,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[label](_responsive_prayer_.responsiveprayer.md#label)*

*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L121)*
*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L121)*

A human-readable name; either the name of the whole liturgy, or a label for a piece.

@@ -237,7 +237,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[language](_responsive_prayer_.responsiveprayer.md#language)*

*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L133)*
*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L133)*

Language code (typically an ISO 639-1 two-letter code)

@@ -252,7 +252,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[lastRevision](_responsive_prayer_.responsiveprayer.md#lastrevision)*

*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L109)*
*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L109)*

Version number of the document

@@ -264,7 +264,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[lookup](_responsive_prayer_.responsiveprayer.md#optional-lookup)*

*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L183)*
*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L183)*

Instructs the client to look up more information from the server

@@ -288,7 +288,7 @@ ___

*Overrides [Rubric](_rubric_.rubric.md).[metadata](_rubric_.rubric.md#optional-metadata)*

*Defined in [heading.ts:16](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L16)*
*Defined in [heading.ts:16](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L16)*

#### Type declaration:

@@ -302,7 +302,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[sharing](_responsive_prayer_.responsiveprayer.md#optional-sharing)*

*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L106)*
*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L106)*

Permissions for this document: whether it's public, shared with particular individuals, etc.

@@ -314,7 +314,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[slug](_responsive_prayer_.responsiveprayer.md#slug)*

*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L115)*
*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L115)*

An identifying slug. Given the `slug`, the API should be able to identify this document.

@@ -329,7 +329,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[source](_responsive_prayer_.responsiveprayer.md#optional-source)*

*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L149)*
*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L149)*

Source for the physical resource within which the document can be found

@@ -344,7 +344,7 @@ ___

*Overrides [Liturgy](_liturgy_liturgy_.liturgy.md).[style](_liturgy_liturgy_.liturgy.md#optional-style)*

*Defined in [heading.ts:14](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L14)*
*Defined in [heading.ts:14](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L14)*

What kind of value to display
If `text`, displays plain text stored in `value`
@@ -359,7 +359,7 @@ ___

*Overrides [LiturgicalDocument](_liturgical_document_.liturgicaldocument.md).[type](_liturgical_document_.liturgicaldocument.md#type)*

*Defined in [heading.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L7)*
*Defined in [heading.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L7)*

___

@@ -369,7 +369,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[uid](_responsive_prayer_.responsiveprayer.md#optional-uid)*

*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L155)*
*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L155)*

Optional: A unique identifying string based on the slug, for compiled liturgies with multiple instances of the same prayer.

@@ -384,7 +384,7 @@ ___

*Overrides [LiturgicalDocument](_liturgical_document_.liturgicaldocument.md).[value](_liturgical_document_.liturgicaldocument.md#optional-value)*

*Defined in [heading.ts:27](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L27)*
*Defined in [heading.ts:27](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L27)*

Contains the text of the heading
value[0] appears as the main heading
@@ -399,7 +399,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[version](_responsive_prayer_.responsiveprayer.md#version)*

*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L139)*
*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L139)*

Identifying code for the version of a liturgy, prayer, psalm, or Bible reading.

@@ -414,7 +414,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[version_label](_responsive_prayer_.responsiveprayer.md#optional-version_label)*

*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L127)*
*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L127)*

Optional: A human-readable name for this particular version of a larger category of prayer or liturgy.

@@ -429,7 +429,7 @@ Optional: A human-readable name for this particular version of a larger category

*Overrides [Meditation](_meditation_.meditation.md).[availableDisplayFormats](_meditation_.meditation.md#availabledisplayformats)*

*Defined in [heading.ts:35](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L35)*
*Defined in [heading.ts:35](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L35)*

No meaningful difference in display formats for this type

@@ -443,7 +443,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[availableLookupTypes](_responsive_prayer_.responsiveprayer.md#availablelookuptypes)*

*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L222)*
*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L222)*

Returns the list of all possible `lookup.type` values

@@ -457,7 +457,7 @@ ___

*Overrides [Liturgy](_liturgy_liturgy_.liturgy.md).[availableStyles](_liturgy_liturgy_.liturgy.md#availablestyles)*

*Defined in [heading.ts:30](https://github.com/gbj/venite/blob/3c92166c/ldf/src/heading.ts#L30)*
*Defined in [heading.ts:30](https://github.com/gbj/venite/blob/8e444889/ldf/src/heading.ts#L30)*

Returns the list of all possible `style` values.

@@ -471,7 +471,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[availableTypes](_responsive_prayer_.responsiveprayer.md#availabletypes)*

*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L212)*
*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L212)*

Returns the list of all possible `type` values

@@ -485,7 +485,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[include](_responsive_prayer_.responsiveprayer.md#include)*

*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L190)*
*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L190)*

Evaluates the full set of conditions attached to the document and returns a boolean of whether it should be included
given the day and assigned preferences
62 ldf/docs/classes/_image_.image.md
View file
@@ -60,7 +60,7 @@ Refrain represents a short text like the Gloria Patri, Hail Mary, or an Antiphon

*Overrides [Liturgy](_liturgy_liturgy_.liturgy.md).[constructor](_liturgy_liturgy_.liturgy.md#constructor)*

*Defined in [image.ts:25](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L25)*
*Defined in [image.ts:25](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L25)*

**Parameters:**

@@ -78,7 +78,7 @@ Name | Type | Default |

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[api](_responsive_prayer_.responsiveprayer.md#optional-api)*

*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L103)*
*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L103)*

The URL (as a string) for the API that provided the document, or against which it can be compiled.

@@ -90,7 +90,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[category](_responsive_prayer_.responsiveprayer.md#category)*

*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L93)*
*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L93)*

Category tags allow searches for things like 'Psalm', 'Canticle', 'Confession', 'Eucharist'.

@@ -102,7 +102,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[citation](_responsive_prayer_.responsiveprayer.md#optional-citation)*

*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L144)*
*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L144)*

Biblical or other citation for the document.

@@ -117,7 +117,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[condition](_responsive_prayer_.responsiveprayer.md#condition)*

*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L96)*
*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L96)*

An array of `Conditions`s determining whether the document should be displayed, given its day.

@@ -135,7 +135,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[date_created](_responsive_prayer_.responsiveprayer.md#optional-date_created)*

*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L72)*
*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L72)*

Timestamps for document creation and modification

@@ -147,7 +147,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[date_modified](_responsive_prayer_.responsiveprayer.md#optional-date_modified)*

*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L73)*
*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L73)*

___

@@ -157,7 +157,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[day](_responsive_prayer_.responsiveprayer.md#optional-day)*

*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L160)*
*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L160)*

Optional: The liturgical day against which to compile the value, or against which a liturgy has been compiled.
[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)
@@ -170,7 +170,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[display_format](_responsive_prayer_.responsiveprayer.md#optional-display_format)*

*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L87)*
*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L87)*

Specify how the text should be displayed
Unison: the entire text is a congregational response
@@ -186,7 +186,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[display_settings](_responsive_prayer_.responsiveprayer.md#optional-display_settings)*

*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L90)*
*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L90)*

Display Settings (font, etc.) to be applied to the document as a whole

@@ -198,7 +198,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[hidden](_responsive_prayer_.responsiveprayer.md#hidden)*

*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L171)*
*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L171)*

Marks a document hidden, so it will not display but will not be deleted
Typically used to a hide a subdocument within a larger liturgy without removing it entirely from the structure,
@@ -212,7 +212,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[id](_responsive_prayer_.responsiveprayer.md#optional-id)*

*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L69)*
*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L69)*

If provided from a database, `id` is unique identifier/DB primary key

@@ -224,7 +224,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[label](_responsive_prayer_.responsiveprayer.md#label)*

*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L121)*
*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L121)*

A human-readable name; either the name of the whole liturgy, or a label for a piece.

@@ -239,7 +239,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[language](_responsive_prayer_.responsiveprayer.md#language)*

*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L133)*
*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L133)*

Language code (typically an ISO 639-1 two-letter code)

@@ -254,7 +254,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[lastRevision](_responsive_prayer_.responsiveprayer.md#lastrevision)*

*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L109)*
*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L109)*

Version number of the document

@@ -266,7 +266,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[lookup](_responsive_prayer_.responsiveprayer.md#optional-lookup)*

*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L183)*
*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L183)*

Instructs the client to look up more information from the server

@@ -290,7 +290,7 @@ ___

*Overrides [Rubric](_rubric_.rubric.md).[metadata](_rubric_.rubric.md#optional-metadata)*

*Defined in [image.ts:10](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L10)*
*Defined in [image.ts:10](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L10)*

#### Type declaration:

@@ -308,7 +308,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[sharing](_responsive_prayer_.responsiveprayer.md#optional-sharing)*

*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L106)*
*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L106)*

Permissions for this document: whether it's public, shared with particular individuals, etc.

@@ -320,7 +320,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[slug](_responsive_prayer_.responsiveprayer.md#slug)*

*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L115)*
*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L115)*

An identifying slug. Given the `slug`, the API should be able to identify this document.

@@ -335,7 +335,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[source](_responsive_prayer_.responsiveprayer.md#optional-source)*

*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L149)*
*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L149)*

Source for the physical resource within which the document can be found

@@ -350,7 +350,7 @@ ___

*Overrides [Liturgy](_liturgy_liturgy_.liturgy.md).[style](_liturgy_liturgy_.liturgy.md#optional-style)*

*Defined in [image.ts:9](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L9)*
*Defined in [image.ts:9](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L9)*

___

@@ -360,7 +360,7 @@ ___

*Overrides [LiturgicalDocument](_liturgical_document_.liturgicaldocument.md).[type](_liturgical_document_.liturgicaldocument.md#type)*

*Defined in [image.ts:8](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L8)*
*Defined in [image.ts:8](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L8)*

___

@@ -370,7 +370,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[uid](_responsive_prayer_.responsiveprayer.md#optional-uid)*

*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L155)*
*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L155)*

Optional: A unique identifying string based on the slug, for compiled liturgies with multiple instances of the same prayer.

@@ -385,7 +385,7 @@ ___

*Overrides [LiturgicalDocument](_liturgical_document_.liturgicaldocument.md).[value](_liturgical_document_.liturgicaldocument.md#optional-value)*

*Defined in [image.ts:16](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L16)*
*Defined in [image.ts:16](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L16)*

Array of image URLs, including (possibly) base-64-encoded images

@@ -397,7 +397,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[version](_responsive_prayer_.responsiveprayer.md#version)*

*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L139)*
*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L139)*

Identifying code for the version of a liturgy, prayer, psalm, or Bible reading.

@@ -412,7 +412,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[version_label](_responsive_prayer_.responsiveprayer.md#optional-version_label)*

*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L127)*
*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L127)*

Optional: A human-readable name for this particular version of a larger category of prayer or liturgy.

@@ -427,7 +427,7 @@ Optional: A human-readable name for this particular version of a larger category

*Overrides [Meditation](_meditation_.meditation.md).[availableDisplayFormats](_meditation_.meditation.md#availabledisplayformats)*

*Defined in [image.ts:23](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L23)*
*Defined in [image.ts:23](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L23)*

**Returns:** *never[]*

@@ -439,7 +439,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[availableLookupTypes](_responsive_prayer_.responsiveprayer.md#availablelookuptypes)*

*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L222)*
*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L222)*

Returns the list of all possible `lookup.type` values

@@ -453,7 +453,7 @@ ___

*Overrides [Liturgy](_liturgy_liturgy_.liturgy.md).[availableStyles](_liturgy_liturgy_.liturgy.md#availablestyles)*

*Defined in [image.ts:19](https://github.com/gbj/venite/blob/3c92166c/ldf/src/image.ts#L19)*
*Defined in [image.ts:19](https://github.com/gbj/venite/blob/8e444889/ldf/src/image.ts#L19)*

Returns the list of all possible `style` values. Child classes should override if they have styles available.

@@ -467,7 +467,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[availableTypes](_responsive_prayer_.responsiveprayer.md#availabletypes)*

*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L212)*
*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L212)*

Returns the list of all possible `type` values

@@ -481,7 +481,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[include](_responsive_prayer_.responsiveprayer.md#include)*

*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L190)*
*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L190)*

Evaluates the full set of conditions attached to the document and returns a boolean of whether it should be included
given the day and assigned preferences
12 ldf/docs/classes/_lectionary_entry_.lectionaryentry.md
View file
@@ -23,44 +23,44 @@

• **citation**: *string*

*Defined in [lectionary-entry.ts:3](https://github.com/gbj/venite/blob/3c92166c/ldf/src/lectionary-entry.ts#L3)*
*Defined in [lectionary-entry.ts:3](https://github.com/gbj/venite/blob/8e444889/ldf/src/lectionary-entry.ts#L3)*

___

### `Optional` day

• **day**? : *undefined | string*

*Defined in [lectionary-entry.ts:4](https://github.com/gbj/venite/blob/3c92166c/ldf/src/lectionary-entry.ts#L4)*
*Defined in [lectionary-entry.ts:4](https://github.com/gbj/venite/blob/8e444889/ldf/src/lectionary-entry.ts#L4)*

___

### `Optional` lectionary

• **lectionary**? : *undefined | string*

*Defined in [lectionary-entry.ts:2](https://github.com/gbj/venite/blob/3c92166c/ldf/src/lectionary-entry.ts#L2)*
*Defined in [lectionary-entry.ts:2](https://github.com/gbj/venite/blob/8e444889/ldf/src/lectionary-entry.ts#L2)*

___

### `Optional` type

• **type**? : *undefined | string*

*Defined in [lectionary-entry.ts:5](https://github.com/gbj/venite/blob/3c92166c/ldf/src/lectionary-entry.ts#L5)*
*Defined in [lectionary-entry.ts:5](https://github.com/gbj/venite/blob/8e444889/ldf/src/lectionary-entry.ts#L5)*

___

### `Optional` when

• **when**? : *number | string*

*Defined in [lectionary-entry.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/lectionary-entry.ts#L7)*
*Defined in [lectionary-entry.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/lectionary-entry.ts#L7)*

___

### `Optional` whentype

• **whentype**? : *undefined | string*

*Defined in [lectionary-entry.ts:6](https://github.com/gbj/venite/blob/3c92166c/ldf/src/lectionary-entry.ts#L6)*
*Defined in [lectionary-entry.ts:6](https://github.com/gbj/venite/blob/8e444889/ldf/src/lectionary-entry.ts#L6)*
62 ldf/docs/classes/_liturgical_document_.liturgicaldocument.md
View file
@@ -78,7 +78,7 @@ Represents a liturgy of any scope and concreteness, from a complete bullletin to

\+ **new LiturgicalDocument**(`data`: Partial‹[LiturgicalDocument](_liturgical_document_.liturgicaldocument.md)›): *[LiturgicalDocument](_liturgical_document_.liturgicaldocument.md)*

*Defined in [liturgical-document.ts:229](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L229)*
*Defined in [liturgical-document.ts:229](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L229)*

**Parameters:**

@@ -94,7 +94,7 @@ Name | Type | Default |

• **api**? : *undefined | string*

*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L103)*
*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L103)*

The URL (as a string) for the API that provided the document, or against which it can be compiled.

@@ -104,7 +104,7 @@ ___

• **category**: *string[]*

*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L93)*
*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L93)*

Category tags allow searches for things like 'Psalm', 'Canticle', 'Confession', 'Eucharist'.

@@ -114,7 +114,7 @@ ___

• **citation**? : *string | null*

*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L144)*
*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L144)*

Biblical or other citation for the document.

@@ -127,7 +127,7 @@ ___

• **condition**: *object*

*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L96)*
*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L96)*

An array of `Conditions`s determining whether the document should be displayed, given its day.

@@ -143,7 +143,7 @@ ___

• **date_created**? : *any*

*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L72)*
*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L72)*

Timestamps for document creation and modification

@@ -153,15 +153,15 @@ ___

• **date_modified**? : *any*

*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L73)*
*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L73)*

___

### `Optional` day

• **day**? : *[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)*

*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L160)*
*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L160)*

Optional: The liturgical day against which to compile the value, or against which a liturgy has been compiled.
[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)
@@ -172,7 +172,7 @@ ___

• **display_format**? : *[DisplayFormat](../modules/_liturgical_document_.md#displayformat)*

*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L87)*
*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L87)*

Specify how the text should be displayed
Unison: the entire text is a congregational response
@@ -186,7 +186,7 @@ ___

• **display_settings**? : *[DisplaySettings](_display_settings_.displaysettings.md)*

*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L90)*
*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L90)*

Display Settings (font, etc.) to be applied to the document as a whole

@@ -196,7 +196,7 @@ ___

• **hidden**: *boolean* = false

*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L171)*
*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L171)*

Marks a document hidden, so it will not display but will not be deleted
Typically used to a hide a subdocument within a larger liturgy without removing it entirely from the structure,
@@ -208,7 +208,7 @@ ___

• **id**? : *number | string*

*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L69)*
*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L69)*

If provided from a database, `id` is unique identifier/DB primary key

@@ -218,7 +218,7 @@ ___

• **label**: *string*

*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L121)*
*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L121)*

A human-readable name; either the name of the whole liturgy, or a label for a piece.

@@ -231,7 +231,7 @@ ___

• **language**: *string*

*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L133)*
*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L133)*

Language code (typically an ISO 639-1 two-letter code)

@@ -244,7 +244,7 @@ ___

• **lastRevision**: *number*

*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L109)*
*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L109)*

Version number of the document

@@ -254,7 +254,7 @@ ___

• **lookup**? : *[Lookup](../modules/_liturgical_document_.md#lookup)*

*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L183)*
*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L183)*

Instructs the client to look up more information from the server

@@ -276,7 +276,7 @@ ___

• **metadata**? : *any*

*Defined in [liturgical-document.ts:166](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L166)*
*Defined in [liturgical-document.ts:166](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L166)*

Optional: Child classes can store any additional properties they need within the `metadata` object.

@@ -289,7 +289,7 @@ ___

• **sharing**? : *[Sharing](_sharing_sharing_.sharing.md)*

*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L106)*
*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L106)*

Permissions for this document: whether it's public, shared with particular individuals, etc.

@@ -299,7 +299,7 @@ ___

• **slug**: *string*

*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L115)*
*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L115)*

An identifying slug. Given the `slug`, the API should be able to identify this document.

@@ -312,7 +312,7 @@ ___

• **source**? : *[Citation](_citation_citation_.citation.md) | null*

*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L149)*
*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L149)*

Source for the physical resource within which the document can be found

@@ -325,7 +325,7 @@ ___

• **style**? : *string | null*

*Defined in [liturgical-document.ts:79](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L79)*
*Defined in [liturgical-document.ts:79](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L79)*

An optional string that clarifies the variety; for example, a `Text` could be of the `prayer` style.

@@ -335,7 +335,7 @@ ___

• **type**: *TypeTuple[number]*

*Defined in [liturgical-document.ts:76](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L76)*
*Defined in [liturgical-document.ts:76](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L76)*

Indicates the type of document

@@ -345,7 +345,7 @@ ___

• **uid**? : *undefined | string*

*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L155)*
*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L155)*

Optional: A unique identifying string based on the slug, for compiled liturgies with multiple instances of the same prayer.

@@ -358,7 +358,7 @@ ___

• **value**? : *[Value](../modules/_liturgical_document_.md#value)*

*Defined in [liturgical-document.ts:186](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L186)*
*Defined in [liturgical-document.ts:186](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L186)*

The content of the document.

@@ -368,7 +368,7 @@ ___

• **version**: *string | object*

*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L139)*
*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L139)*

Identifying code for the version of a liturgy, prayer, psalm, or Bible reading.

@@ -381,7 +381,7 @@ ___

• **version_label**? : *string | null*

*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L127)*
*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L127)*

Optional: A human-readable name for this particular version of a larger category of prayer or liturgy.

@@ -394,7 +394,7 @@ Optional: A human-readable name for this particular version of a larger category

▸ **availableDisplayFormats**(): *ReadonlyArray‹string›*

*Defined in [liturgical-document.ts:227](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L227)*
*Defined in [liturgical-document.ts:227](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L227)*

Returns the list of all available `display_format` values

@@ -406,7 +406,7 @@ ___

▸ **availableLookupTypes**(): *ReadonlyArray‹string›*

*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L222)*
*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L222)*

Returns the list of all possible `lookup.type` values

@@ -418,7 +418,7 @@ ___

▸ **availableStyles**(): *ReadonlyArray‹string›*

*Defined in [liturgical-document.ts:217](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L217)*
*Defined in [liturgical-document.ts:217](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L217)*

Returns the list of all possible `style` values. Child classes should override if they have styles available.

@@ -430,7 +430,7 @@ ___

▸ **availableTypes**(): *ReadonlyArray‹string›*

*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L212)*
*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L212)*

Returns the list of all possible `type` values

@@ -442,7 +442,7 @@ ___

▸ **include**(`day`: [LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md), `prefs`: [ClientPreferences](_liturgy_client_preferences_.clientpreferences.md)): *boolean*

*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L190)*
*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L190)*

Evaluates the full set of conditions attached to the document and returns a boolean of whether it should be included
given the day and assigned preferences
64 ldf/docs/classes/_liturgy_liturgy_.liturgy.md
View file
@@ -60,7 +60,7 @@ Represents the "recipe" to compile a liturgy

*Inherited from [Liturgy](_liturgy_liturgy_.liturgy.md).[constructor](_liturgy_liturgy_.liturgy.md#constructor)*

*Defined in [liturgical-document.ts:229](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L229)*
*Defined in [liturgical-document.ts:229](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L229)*

**Parameters:**

@@ -78,7 +78,7 @@ Name | Type | Default |

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[api](_responsive_prayer_.responsiveprayer.md#optional-api)*

*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L103)*
*Defined in [liturgical-document.ts:103](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L103)*

The URL (as a string) for the API that provided the document, or against which it can be compiled.

@@ -90,7 +90,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[category](_responsive_prayer_.responsiveprayer.md#category)*

*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L93)*
*Defined in [liturgical-document.ts:93](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L93)*

Category tags allow searches for things like 'Psalm', 'Canticle', 'Confession', 'Eucharist'.

@@ -102,7 +102,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[citation](_responsive_prayer_.responsiveprayer.md#optional-citation)*

*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L144)*
*Defined in [liturgical-document.ts:144](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L144)*

Biblical or other citation for the document.

@@ -117,7 +117,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[condition](_responsive_prayer_.responsiveprayer.md#condition)*

*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L96)*
*Defined in [liturgical-document.ts:96](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L96)*

An array of `Conditions`s determining whether the document should be displayed, given its day.

@@ -135,7 +135,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[date_created](_responsive_prayer_.responsiveprayer.md#optional-date_created)*

*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L72)*
*Defined in [liturgical-document.ts:72](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L72)*

Timestamps for document creation and modification

@@ -147,7 +147,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[date_modified](_responsive_prayer_.responsiveprayer.md#optional-date_modified)*

*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L73)*
*Defined in [liturgical-document.ts:73](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L73)*

___

@@ -157,7 +157,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[day](_responsive_prayer_.responsiveprayer.md#optional-day)*

*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L160)*
*Defined in [liturgical-document.ts:160](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L160)*

Optional: The liturgical day against which to compile the value, or against which a liturgy has been compiled.
[LiturgicalDay](_calendar_liturgical_day_.liturgicalday.md)
@@ -170,7 +170,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[display_format](_responsive_prayer_.responsiveprayer.md#optional-display_format)*

*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L87)*
*Defined in [liturgical-document.ts:87](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L87)*

Specify how the text should be displayed
Unison: the entire text is a congregational response
@@ -186,7 +186,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[display_settings](_responsive_prayer_.responsiveprayer.md#optional-display_settings)*

*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L90)*
*Defined in [liturgical-document.ts:90](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L90)*

Display Settings (font, etc.) to be applied to the document as a whole

@@ -198,7 +198,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[hidden](_responsive_prayer_.responsiveprayer.md#hidden)*

*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L171)*
*Defined in [liturgical-document.ts:171](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L171)*

Marks a document hidden, so it will not display but will not be deleted
Typically used to a hide a subdocument within a larger liturgy without removing it entirely from the structure,
@@ -212,7 +212,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[id](_responsive_prayer_.responsiveprayer.md#optional-id)*

*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L69)*
*Defined in [liturgical-document.ts:69](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L69)*

If provided from a database, `id` is unique identifier/DB primary key

@@ -224,7 +224,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[label](_responsive_prayer_.responsiveprayer.md#label)*

*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L121)*
*Defined in [liturgical-document.ts:121](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L121)*

A human-readable name; either the name of the whole liturgy, or a label for a piece.

@@ -239,7 +239,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[language](_responsive_prayer_.responsiveprayer.md#language)*

*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L133)*
*Defined in [liturgical-document.ts:133](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L133)*

Language code (typically an ISO 639-1 two-letter code)

@@ -254,7 +254,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[lastRevision](_responsive_prayer_.responsiveprayer.md#lastrevision)*

*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L109)*
*Defined in [liturgical-document.ts:109](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L109)*

Version number of the document

@@ -266,7 +266,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[lookup](_responsive_prayer_.responsiveprayer.md#optional-lookup)*

*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L183)*
*Defined in [liturgical-document.ts:183](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L183)*

Instructs the client to look up more information from the server

@@ -290,7 +290,7 @@ ___

*Overrides [Rubric](_rubric_.rubric.md).[metadata](_rubric_.rubric.md#optional-metadata)*

*Defined in [liturgy/liturgy.ts:9](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgy/liturgy.ts#L9)*
*Defined in [liturgy/liturgy.ts:9](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgy/liturgy.ts#L9)*

#### Type declaration:

@@ -304,6 +304,8 @@ ___

* **preferences**(): *object*

* **pronouns**? : *string[]*

* **special_preferences**(): *object*

* **supplement**? : *undefined | false | true*
@@ -316,7 +318,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[sharing](_responsive_prayer_.responsiveprayer.md#optional-sharing)*

*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L106)*
*Defined in [liturgical-document.ts:106](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L106)*

Permissions for this document: whether it's public, shared with particular individuals, etc.

@@ -328,7 +330,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[slug](_responsive_prayer_.responsiveprayer.md#slug)*

*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L115)*
*Defined in [liturgical-document.ts:115](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L115)*

An identifying slug. Given the `slug`, the API should be able to identify this document.

@@ -343,7 +345,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[source](_responsive_prayer_.responsiveprayer.md#optional-source)*

*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L149)*
*Defined in [liturgical-document.ts:149](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L149)*

Source for the physical resource within which the document can be found

@@ -358,7 +360,7 @@ ___

*Inherited from [Liturgy](_liturgy_liturgy_.liturgy.md).[style](_liturgy_liturgy_.liturgy.md#optional-style)*

*Defined in [liturgical-document.ts:79](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L79)*
*Defined in [liturgical-document.ts:79](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L79)*

An optional string that clarifies the variety; for example, a `Text` could be of the `prayer` style.

@@ -370,7 +372,7 @@ ___

*Overrides [LiturgicalDocument](_liturgical_document_.liturgicaldocument.md).[type](_liturgical_document_.liturgicaldocument.md#type)*

*Defined in [liturgy/liturgy.ts:7](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgy/liturgy.ts#L7)*
*Defined in [liturgy/liturgy.ts:7](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgy/liturgy.ts#L7)*

___

@@ -380,7 +382,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[uid](_responsive_prayer_.responsiveprayer.md#optional-uid)*

*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L155)*
*Defined in [liturgical-document.ts:155](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L155)*

Optional: A unique identifying string based on the slug, for compiled liturgies with multiple instances of the same prayer.

@@ -395,7 +397,7 @@ ___

*Overrides [LiturgicalDocument](_liturgical_document_.liturgicaldocument.md).[value](_liturgical_document_.liturgicaldocument.md#optional-value)*

*Defined in [liturgy/liturgy.ts:49](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgy/liturgy.ts#L49)*
*Defined in [liturgy/liturgy.ts:52](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgy/liturgy.ts#L52)*

Value is an array of any kind of LiturgicalDocument, including child classes

@@ -407,7 +409,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[version](_responsive_prayer_.responsiveprayer.md#version)*

*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L139)*
*Defined in [liturgical-document.ts:139](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L139)*

Identifying code for the version of a liturgy, prayer, psalm, or Bible reading.

@@ -422,7 +424,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[version_label](_responsive_prayer_.responsiveprayer.md#optional-version_label)*

*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L127)*
*Defined in [liturgical-document.ts:127](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L127)*

Optional: A human-readable name for this particular version of a larger category of prayer or liturgy.

@@ -437,7 +439,7 @@ Optional: A human-readable name for this particular version of a larger category

*Overrides [Meditation](_meditation_.meditation.md).[availableDisplayFormats](_meditation_.meditation.md#availabledisplayformats)*

*Defined in [liturgy/liturgy.ts:52](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgy/liturgy.ts#L52)*
*Defined in [liturgy/liturgy.ts:55](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgy/liturgy.ts#L55)*

No meaningful differences in display format for liturgies

@@ -451,7 +453,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[availableLookupTypes](_responsive_prayer_.responsiveprayer.md#availablelookuptypes)*

*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L222)*
*Defined in [liturgical-document.ts:222](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L222)*

Returns the list of all possible `lookup.type` values

@@ -465,7 +467,7 @@ ___

*Inherited from [Liturgy](_liturgy_liturgy_.liturgy.md).[availableStyles](_liturgy_liturgy_.liturgy.md#availablestyles)*

*Defined in [liturgical-document.ts:217](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L217)*
*Defined in [liturgical-document.ts:217](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L217)*

Returns the list of all possible `style` values. Child classes should override if they have styles available.

@@ -479,7 +481,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[availableTypes](_responsive_prayer_.responsiveprayer.md#availabletypes)*

*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L212)*
*Defined in [liturgical-document.ts:212](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L212)*

Returns the list of all possible `type` values

@@ -493,7 +495,7 @@ ___

*Inherited from [ResponsivePrayer](_responsive_prayer_.responsiveprayer.md).[include](_responsive_prayer_.responsiveprayer.md#include)*

*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/3c92166c/ldf/src/liturgical-document.ts#L190)*
*Defined in [liturgical-document.ts:190](https://github.com/gbj/venite/blob/8e444889/ldf/src/liturgical-document.ts#L190)*

Evaluates the full set of conditions attached to the document and returns a boolean of whether it should be included
given the day and assigned preferences