Skip to content

Commit 6dbc549

Browse files
committed
Rambam 1-chapter a day cycle
1 parent 07dce08 commit 6dbc549

8 files changed

+171
-1133
lines changed

README.md

+65
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ and Ketuvim (Writings).</p>
4747
<dt><a href="#ChofetzChaimEvent">ChofetzChaimEvent</a></dt>
4848
<dd><p>Event wrapper around a Chofetz Chaim instance</p>
4949
</dd>
50+
<dt><a href="#DailyRambamEvent">DailyRambamEvent</a></dt>
51+
<dd><p>Event wrapper around a Daily Rambam instance</p>
52+
</dd>
5053
</dl>
5154

5255
## Constants
@@ -79,6 +82,9 @@ cycle began (2 February 1980 for Vilna,
7982
<dt><a href="#chofetzChaim">chofetzChaim(hdate)</a> ⇒ <code>any</code></dt>
8083
<dd><p>Looks up Chofetz Chaim Calendar for date</p>
8184
</dd>
85+
<dt><a href="#dailyRambam1">dailyRambam1(date)</a> ⇒ <code>any</code></dt>
86+
<dd><p>Calculates Daily Rambam (Mishneh Torah) for 1 chapter a day cycle.</p>
87+
</dd>
8288
</dl>
8389

8490
## Typedefs
@@ -401,6 +407,7 @@ Event wrapper around a Chofetz Chaim instance
401407
* [new ChofetzChaimEvent(date, reading)](#new_ChofetzChaimEvent_new)
402408
* [.render([locale])](#ChofetzChaimEvent+render) ⇒ <code>string</code>
403409
* [.url()](#ChofetzChaimEvent+url) ⇒ <code>string</code>
410+
* [.getCategories()](#ChofetzChaimEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
404411

405412
<a name="new_ChofetzChaimEvent_new"></a>
406413

@@ -429,6 +436,53 @@ Returns a link to sefaria.org
429436
e.g. https://www.sefaria.org/Chofetz_Chaim%2C_Part_One%2C_The_Prohibition_Against_Lashon_Hara%2C_Principle_7.7
430437

431438
**Kind**: instance method of [<code>ChofetzChaimEvent</code>](#ChofetzChaimEvent)
439+
<a name="ChofetzChaimEvent+getCategories"></a>
440+
441+
### chofetzChaimEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
442+
**Kind**: instance method of [<code>ChofetzChaimEvent</code>](#ChofetzChaimEvent)
443+
<a name="DailyRambamEvent"></a>
444+
445+
## DailyRambamEvent
446+
Event wrapper around a Daily Rambam instance
447+
448+
**Kind**: global class
449+
450+
* [DailyRambamEvent](#DailyRambamEvent)
451+
* [new DailyRambamEvent(date, reading)](#new_DailyRambamEvent_new)
452+
* [.render([locale])](#DailyRambamEvent+render) ⇒ <code>string</code>
453+
* [.url()](#DailyRambamEvent+url) ⇒ <code>string</code>
454+
* [.getCategories()](#DailyRambamEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
455+
456+
<a name="new_DailyRambamEvent_new"></a>
457+
458+
### new DailyRambamEvent(date, reading)
459+
460+
| Param | Type |
461+
| --- | --- |
462+
| date | <code>HDate</code> |
463+
| reading | <code>any</code> |
464+
465+
<a name="DailyRambamEvent+render"></a>
466+
467+
### dailyRambamEvent.render([locale]) ⇒ <code>string</code>
468+
Returns name of reading
469+
470+
**Kind**: instance method of [<code>DailyRambamEvent</code>](#DailyRambamEvent)
471+
472+
| Param | Type | Description |
473+
| --- | --- | --- |
474+
| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
475+
476+
<a name="DailyRambamEvent+url"></a>
477+
478+
### dailyRambamEvent.url() ⇒ <code>string</code>
479+
Returns a link to sefaria.org
480+
481+
**Kind**: instance method of [<code>DailyRambamEvent</code>](#DailyRambamEvent)
482+
<a name="DailyRambamEvent+getCategories"></a>
483+
484+
### dailyRambamEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
485+
**Kind**: instance method of [<code>DailyRambamEvent</code>](#DailyRambamEvent)
432486
<a name="vilna"></a>
433487

434488
## vilna
@@ -478,6 +532,17 @@ Looks up Chofetz Chaim Calendar for date
478532
| --- | --- |
479533
| hdate | <code>HDate</code> |
480534

535+
<a name="dailyRambam1"></a>
536+
537+
## dailyRambam1(date) ⇒ <code>any</code>
538+
Calculates Daily Rambam (Mishneh Torah) for 1 chapter a day cycle.
539+
540+
**Kind**: global function
541+
542+
| Param | Type | Description |
543+
| --- | --- | --- |
544+
| date | <code>HDate</code> \| <code>Date</code> \| <code>number</code> | Hebrew or Gregorian date |
545+
481546
<a name="MishnaYomi"></a>
482547

483548
## MishnaYomi : <code>Object</code>

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hebcal/learning",
3-
"version": "1.1.2",
3+
"version": "1.2.0",
44
"description": "Daily learning schedules: Daf Yomi, Mishna Yomi, etc",
55
"main": "dist/index.js",
66
"module": "dist/index.mjs",
@@ -10,7 +10,7 @@
1010
},
1111
"typings": "types.d.ts",
1212
"engines": {
13-
"node": ">= 12.17.0"
13+
"node": ">= 14.0.0"
1414
},
1515
"repository": {
1616
"type": "git",

src/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ export {NachYomiEvent} from './NachYomiEvent';
66
export {NachYomiIndex, nachYomiStart} from './nachYomi';
77
export {yerushalmiYomi, YerushalmiYomiEvent, vilna, schottenstein} from './yerushalmi';
88
export {chofetzChaim, ChofetzChaimEvent} from './chofetzChaim';
9-
export {dailyRambam1} from './rambam';
9+
export {dailyRambam1, DailyRambamEvent} from './rambam';

0 commit comments

Comments
 (0)