@hebcal/core 3.33.5 → 3.34.0

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 CHANGED
@@ -1130,12 +1130,15 @@ Class representing halachic times
1130
1130
  * [.misheyakirMachmir()](#Zmanim+misheyakirMachmir) ⇒ <code>Date</code>
1131
1131
  * [.sofZmanShma()](#Zmanim+sofZmanShma) ⇒ <code>Date</code>
1132
1132
  * [.sofZmanTfilla()](#Zmanim+sofZmanTfilla) ⇒ <code>Date</code>
1133
+ * [.sofZmanShmaMGA()](#Zmanim+sofZmanShmaMGA) ⇒ <code>Date</code>
1134
+ * [.sofZmanTfillaMGA()](#Zmanim+sofZmanTfillaMGA) ⇒ <code>Date</code>
1133
1135
  * [.minchaGedola()](#Zmanim+minchaGedola) ⇒ <code>Date</code>
1134
1136
  * [.minchaKetana()](#Zmanim+minchaKetana) ⇒ <code>Date</code>
1135
1137
  * [.plagHaMincha()](#Zmanim+plagHaMincha) ⇒ <code>Date</code>
1136
1138
  * [.tzeit([angle])](#Zmanim+tzeit) ⇒ <code>Date</code>
1137
1139
  * [.neitzHaChama()](#Zmanim+neitzHaChama) ⇒ <code>Date</code>
1138
1140
  * [.shkiah()](#Zmanim+shkiah) ⇒ <code>Date</code>
1141
+ * [.sunriseOffset(offset)](#Zmanim+sunriseOffset) ⇒ <code>Date</code>
1139
1142
  * [.sunsetOffset(offset)](#Zmanim+sunsetOffset) ⇒ <code>Date</code>
1140
1143
  * ~~[.sunsetOffsetTime(offset, timeFormat)](#Zmanim+sunsetOffsetTime) ⇒ <code>Array.&lt;Object&gt;</code>~~
1141
1144
  * ~~[.tzeitTime(angle, timeFormat)](#Zmanim+tzeitTime) ⇒ <code>Array.&lt;Object&gt;</code>~~
@@ -1166,18 +1169,26 @@ Initialize a Zmanim instance.
1166
1169
  <a name="Zmanim+sunrise"></a>
1167
1170
 
1168
1171
  ### zmanim.sunrise() ⇒ <code>Date</code>
1172
+ Upper edge of the Sun appears over the eastern horizon in the morning (0.833° above horizon)
1173
+
1169
1174
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1170
1175
  <a name="Zmanim+sunset"></a>
1171
1176
 
1172
1177
  ### zmanim.sunset() ⇒ <code>Date</code>
1178
+ When the upper edge of the Sun disappears below the horizon (0.833° below horizon)
1179
+
1173
1180
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1174
1181
  <a name="Zmanim+dawn"></a>
1175
1182
 
1176
1183
  ### zmanim.dawn() ⇒ <code>Date</code>
1184
+ Civil dawn; Sun is 6° below the horizon in the morning
1185
+
1177
1186
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1178
1187
  <a name="Zmanim+dusk"></a>
1179
1188
 
1180
1189
  ### zmanim.dusk() ⇒ <code>Date</code>
1190
+ Civil dusk; Sun is 6° below the horizon in the evening
1191
+
1181
1192
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1182
1193
  <a name="Zmanim+hour"></a>
1183
1194
 
@@ -1211,42 +1222,74 @@ Initialize a Zmanim instance.
1211
1222
  <a name="Zmanim+chatzot"></a>
1212
1223
 
1213
1224
  ### zmanim.chatzot() ⇒ <code>Date</code>
1225
+ Midday – Chatzot; Sunrise plus 6 halachic hours
1226
+
1214
1227
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1215
1228
  <a name="Zmanim+chatzotNight"></a>
1216
1229
 
1217
1230
  ### zmanim.chatzotNight() ⇒ <code>Date</code>
1231
+ Midnight – Chatzot; Sunset plus 6 halachic hours
1232
+
1218
1233
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1219
1234
  <a name="Zmanim+alotHaShachar"></a>
1220
1235
 
1221
1236
  ### zmanim.alotHaShachar() ⇒ <code>Date</code>
1237
+ Dawn – Alot haShachar; Sun is 16.1° below the horizon in the morning
1238
+
1222
1239
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1223
1240
  <a name="Zmanim+misheyakir"></a>
1224
1241
 
1225
1242
  ### zmanim.misheyakir() ⇒ <code>Date</code>
1243
+ Earliest talis & tefillin – Misheyakir; Sun is 11.5° below the horizon in the morning
1244
+
1226
1245
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1227
1246
  <a name="Zmanim+misheyakirMachmir"></a>
1228
1247
 
1229
1248
  ### zmanim.misheyakirMachmir() ⇒ <code>Date</code>
1249
+ Earliest talis & tefillin – Misheyakir Machmir; Sun is 10.2° below the horizon in the morning
1250
+
1230
1251
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1231
1252
  <a name="Zmanim+sofZmanShma"></a>
1232
1253
 
1233
1254
  ### zmanim.sofZmanShma() ⇒ <code>Date</code>
1255
+ Latest Shema (Gra); Sunrise plus 3 halachic hours, according to the Gra
1256
+
1234
1257
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1235
1258
  <a name="Zmanim+sofZmanTfilla"></a>
1236
1259
 
1237
1260
  ### zmanim.sofZmanTfilla() ⇒ <code>Date</code>
1261
+ Latest Shacharit (Gra); Sunrise plus 4 halachic hours, according to the Gra
1262
+
1263
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1264
+ <a name="Zmanim+sofZmanShmaMGA"></a>
1265
+
1266
+ ### zmanim.sofZmanShmaMGA() ⇒ <code>Date</code>
1267
+ Latest Shema (MGA); Sunrise plus 3 halachic hours, according to Magen Avraham
1268
+
1269
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1270
+ <a name="Zmanim+sofZmanTfillaMGA"></a>
1271
+
1272
+ ### zmanim.sofZmanTfillaMGA() ⇒ <code>Date</code>
1273
+ Latest Shacharit (MGA); Sunrise plus 4 halachic hours, according to Magen Avraham
1274
+
1238
1275
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1239
1276
  <a name="Zmanim+minchaGedola"></a>
1240
1277
 
1241
1278
  ### zmanim.minchaGedola() ⇒ <code>Date</code>
1279
+ Earliest Mincha – Mincha Gedola; Sunrise plus 6.5 halachic hours
1280
+
1242
1281
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1243
1282
  <a name="Zmanim+minchaKetana"></a>
1244
1283
 
1245
1284
  ### zmanim.minchaKetana() ⇒ <code>Date</code>
1285
+ Preferable earliest time to recite Minchah – Mincha Ketana; Sunrise plus 9.5 halachic hours
1286
+
1246
1287
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1247
1288
  <a name="Zmanim+plagHaMincha"></a>
1248
1289
 
1249
1290
  ### zmanim.plagHaMincha() ⇒ <code>Date</code>
1291
+ Plag haMincha; Sunrise plus 10.75 halachic hours
1292
+
1250
1293
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1251
1294
  <a name="Zmanim+tzeit"></a>
1252
1295
 
@@ -1260,21 +1303,36 @@ Initialize a Zmanim instance.
1260
1303
  <a name="Zmanim+neitzHaChama"></a>
1261
1304
 
1262
1305
  ### zmanim.neitzHaChama() ⇒ <code>Date</code>
1306
+ Alias for sunrise
1307
+
1263
1308
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1264
1309
  <a name="Zmanim+shkiah"></a>
1265
1310
 
1266
1311
  ### zmanim.shkiah() ⇒ <code>Date</code>
1312
+ Alias for sunset
1313
+
1267
1314
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1315
+ <a name="Zmanim+sunriseOffset"></a>
1316
+
1317
+ ### zmanim.sunriseOffset(offset) ⇒ <code>Date</code>
1318
+ Returns sunrise + `offset` minutes (either positive or negative).
1319
+
1320
+ **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1321
+
1322
+ | Param | Type | Description |
1323
+ | --- | --- | --- |
1324
+ | offset | <code>number</code> | minutes |
1325
+
1268
1326
  <a name="Zmanim+sunsetOffset"></a>
1269
1327
 
1270
1328
  ### zmanim.sunsetOffset(offset) ⇒ <code>Date</code>
1271
- Returns sunset + offset (either positive or negative).
1329
+ Returns sunset + `offset` minutes (either positive or negative).
1272
1330
 
1273
1331
  **Kind**: instance method of [<code>Zmanim</code>](#Zmanim)
1274
1332
 
1275
- | Param | Type |
1276
- | --- | --- |
1277
- | offset | <code>number</code> |
1333
+ | Param | Type | Description |
1334
+ | --- | --- | --- |
1335
+ | offset | <code>number</code> | minutes |
1278
1336
 
1279
1337
  <a name="Zmanim+sunsetOffsetTime"></a>
1280
1338