breviarium 0.2.9 → 0.2.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,9 +11,13 @@
|
|
|
11
11
|
</p>
|
|
12
12
|
|
|
13
13
|
<p align="center">
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
<a href="LICENSE">
|
|
15
|
+
<img alt="License" src="https://img.shields.io/badge/license-MIT-blue?color=blue&style=flat">
|
|
16
|
+
</a>
|
|
17
|
+
<a href="https://www.npmjs.com/package/breviarium/v/latest" target="_blank" rel="noopener noreferrer">
|
|
18
|
+
<img alt="npm breviarium version" src="https://img.shields.io/npm/v/breviarium/latest?style=flat&logo=npm&color=35d401">
|
|
19
|
+
</a>
|
|
20
|
+
|
|
17
21
|
|
|
18
22
|
</p>
|
|
19
23
|
|
|
@@ -25,15 +29,27 @@
|
|
|
25
29
|
|
|
26
30
|
Liturgy of the hours: functions to retrieve the information of the library:
|
|
27
31
|
|
|
28
|
-
| Function
|
|
29
|
-
|
|
30
|
-
| `getLaudes`
|
|
31
|
-
| `getVesperae`
|
|
32
|
-
| `getOfficium`
|
|
33
|
-
| `getTertia`
|
|
34
|
-
| `getSexta`
|
|
35
|
-
| `getNona`
|
|
36
|
-
| `getCompletorium`
|
|
37
|
-
| `getMissaleLectiones`
|
|
38
|
-
| `getEvangelium`
|
|
39
|
-
|
|
32
|
+
| Function | Parameters | Description | Example Call |
|
|
33
|
+
|-----------------------|---------------|----------------------------------------------------|------------------------------------------------|
|
|
34
|
+
| `getLaudes` | `date?: Date` | Returns the Laudes prayer for a given date. | `prayers.getLaudes();` |
|
|
35
|
+
| `getVesperae` | `date?: Date` | Returns the Vesperae prayer for a given date. | `prayers.getVesperae(new Date(2025, 1, 17));` |
|
|
36
|
+
| `getOfficium` | `date?: Date` | Returns the Officium prayer for a given date. | `prayers.getOfficium();` |
|
|
37
|
+
| `getTertia` | `date?: Date` | Returns the Tertia prayer for a given date. | `prayers.getTertia();` |
|
|
38
|
+
| `getSexta` | `date?: Date` | Returns the Sexta prayer for a given date. | `prayers.getSexta(new Date());` |
|
|
39
|
+
| `getNona` | `date?: Date` | Returns the Nona prayer for a given date. | `prayers.getNona();` |
|
|
40
|
+
| `getCompletorium` | `date?: Date` | Returns the Completorium prayer for a given date. | `prayers.getCompletorium();` |
|
|
41
|
+
| `getMissaleLectiones` | `date?: Date` | Returns the Mass readings prayer for a given date. | `prayers.getMissaleLectiones();` |
|
|
42
|
+
| `getEvangelium` | `date?: Date` | Returns the Gospel text for a given date. | `prayers.getEvangelium(new Date(2025, 5, 1));` |
|
|
43
|
+
|
|
44
|
+
## Test
|
|
45
|
+
|
|
46
|
+
To run the test suite (with [vitest](https://vitest.dev/)), execute:
|
|
47
|
+
|
|
48
|
+
To run the app:
|
|
49
|
+
|
|
50
|
+
```shell
|
|
51
|
+
# linux and mac users:
|
|
52
|
+
make test
|
|
53
|
+
# for windows users:
|
|
54
|
+
npm run test
|
|
55
|
+
```
|