Skip to content

Commit 4ebf748

Browse files
committed
Add Sefer Shemirat HaLashon
1 parent bee11d5 commit 4ebf748

9 files changed

+4114
-1607
lines changed

README.md

+62
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Supports several learning schedules
1212
* Vilna edition - `yerushalmi-vilna`
1313
* Schottenstein edition - `yerushalmi-schottenstei`
1414
* Chofetz Chaim - `chofetzChaim`
15+
* Sefer Shemirat HaLashon - `shemiratHaLashon`
1516

1617
## Installation
1718
```bash
@@ -50,6 +51,9 @@ and Ketuvim (Writings).</p>
5051
<dt><a href="#DailyRambamEvent">DailyRambamEvent</a></dt>
5152
<dd><p>Event wrapper around a Daily Rambam instance</p>
5253
</dd>
54+
<dt><a href="#ShemiratHaLashonEvent">ShemiratHaLashonEvent</a></dt>
55+
<dd><p>Event wrapper around a Sefer Shemirat HaLashon instance</p>
56+
</dd>
5357
</dl>
5458

5559
## Constants
@@ -85,6 +89,9 @@ cycle began (2 February 1980 for Vilna,
8589
<dt><a href="#dailyRambam1">dailyRambam1(date)</a> ⇒ <code>any</code></dt>
8690
<dd><p>Calculates Daily Rambam (Mishneh Torah) for 1 chapter a day cycle.</p>
8791
</dd>
92+
<dt><a href="#shemiratHaLashon">shemiratHaLashon(hdate)</a> ⇒ <code>any</code></dt>
93+
<dd><p>Looks up Sefer Shemirat HaLashon Calendar for date</p>
94+
</dd>
8895
</dl>
8996

9097
## Typedefs
@@ -483,6 +490,50 @@ Returns a link to sefaria.org
483490

484491
### dailyRambamEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
485492
**Kind**: instance method of [<code>DailyRambamEvent</code>](#DailyRambamEvent)
493+
<a name="ShemiratHaLashonEvent"></a>
494+
495+
## ShemiratHaLashonEvent
496+
Event wrapper around a Sefer Shemirat HaLashon instance
497+
498+
**Kind**: global class
499+
500+
* [ShemiratHaLashonEvent](#ShemiratHaLashonEvent)
501+
* [new ShemiratHaLashonEvent(date, reading)](#new_ShemiratHaLashonEvent_new)
502+
* [.render([locale])](#ShemiratHaLashonEvent+render) ⇒ <code>string</code>
503+
* [.url()](#ShemiratHaLashonEvent+url) ⇒ <code>string</code>
504+
* [.getCategories()](#ShemiratHaLashonEvent+getCategories) ⇒ <code>Array.&lt;string&gt;</code>
505+
506+
<a name="new_ShemiratHaLashonEvent_new"></a>
507+
508+
### new ShemiratHaLashonEvent(date, reading)
509+
510+
| Param | Type |
511+
| --- | --- |
512+
| date | <code>HDate</code> |
513+
| reading | <code>any</code> |
514+
515+
<a name="ShemiratHaLashonEvent+render"></a>
516+
517+
### shemiratHaLashonEvent.render([locale]) ⇒ <code>string</code>
518+
Returns name of reading
519+
520+
**Kind**: instance method of [<code>ShemiratHaLashonEvent</code>](#ShemiratHaLashonEvent)
521+
522+
| Param | Type | Description |
523+
| --- | --- | --- |
524+
| [locale] | <code>string</code> | Optional locale name (defaults to active locale). |
525+
526+
<a name="ShemiratHaLashonEvent+url"></a>
527+
528+
### shemiratHaLashonEvent.url() ⇒ <code>string</code>
529+
Returns a link to sefaria.org
530+
e.g. https://www.sefaria.org/Shemirat_HaLashon%2C_Book_I%2C_The_Gate_of_Torah.4.2?lang=b
531+
532+
**Kind**: instance method of [<code>ShemiratHaLashonEvent</code>](#ShemiratHaLashonEvent)
533+
<a name="ShemiratHaLashonEvent+getCategories"></a>
534+
535+
### shemiratHaLashonEvent.getCategories() ⇒ <code>Array.&lt;string&gt;</code>
536+
**Kind**: instance method of [<code>ShemiratHaLashonEvent</code>](#ShemiratHaLashonEvent)
486537
<a name="vilna"></a>
487538

488539
## vilna
@@ -543,6 +594,17 @@ Calculates Daily Rambam (Mishneh Torah) for 1 chapter a day cycle.
543594
| --- | --- | --- |
544595
| date | <code>HDate</code> \| <code>Date</code> \| <code>number</code> | Hebrew or Gregorian date |
545596

597+
<a name="shemiratHaLashon"></a>
598+
599+
## shemiratHaLashon(hdate) ⇒ <code>any</code>
600+
Looks up Sefer Shemirat HaLashon Calendar for date
601+
602+
**Kind**: global function
603+
604+
| Param | Type |
605+
| --- | --- |
606+
| hdate | <code>HDate</code> |
607+
546608
<a name="MishnaYomi"></a>
547609

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

0 commit comments

Comments
 (0)