From 6f23519e0375e5e34d06a7abe6b350575b1f64c6 Mon Sep 17 00:00:00 2001 From: "Michael J. Radwin" Date: Sun, 20 Oct 2024 13:21:33 -0700 Subject: [PATCH] latest learning --- api/learning/assets/icons.js | 2 +- api/learning/assets/icons.svg | 2 +- api/learning/assets/main.js | 8 +- api/learning/assets/style.css | 87 ++++++++++++++----- api/learning/classes/ChofetzChaimEvent.html | 52 ++++++----- api/learning/classes/DafPage.html | 6 +- api/learning/classes/DafPageEvent.html | 50 +++++++---- api/learning/classes/DafWeeklyEvent.html | 50 +++++++---- api/learning/classes/DafYomi.html | 6 +- api/learning/classes/DafYomiEvent.html | 50 +++++++---- api/learning/classes/DailyRambamEvent.html | 50 +++++++---- api/learning/classes/MishnaYomiEvent.html | 50 +++++++---- api/learning/classes/MishnaYomiIndex.html | 6 +- api/learning/classes/NachYomiEvent.html | 50 +++++++---- api/learning/classes/NachYomiIndex.html | 6 +- .../classes/PirkeiAvotSummerEvent.html | 50 +++++++---- api/learning/classes/PsalmsEvent.html | 52 ++++++----- .../classes/ShemiratHaLashonEvent.html | 52 ++++++----- api/learning/classes/YerushalmiYomiEvent.html | 50 +++++++---- api/learning/functions/chofetzChaim.html | 2 +- api/learning/functions/dafWeekly.html | 2 +- api/learning/functions/dailyPsalms.html | 2 +- api/learning/functions/dailyRambam1.html | 2 +- api/learning/functions/pirkeiAvot.html | 4 +- api/learning/functions/shemiratHaLashon.html | 2 +- api/learning/functions/yerushalmiYomi.html | 2 +- api/learning/hierarchy.html | 2 +- api/learning/index.html | 6 +- api/learning/modules.html | 4 +- api/learning/types/ChofetzChaimReading.html | 2 +- api/learning/types/MishnaYomi.html | 2 +- api/learning/types/NachYomi.html | 2 +- api/learning/types/PsalmBeginEnd.html | 2 +- api/learning/types/RambamReading.html | 2 +- .../types/ShemiratHaLashonReading.html | 2 +- api/learning/types/YerushalmiReading.html | 2 +- api/learning/variables/dafWeeklyStart.html | 2 +- api/learning/variables/mishnaYomiStart.html | 2 +- api/learning/variables/nachYomiStart.html | 2 +- api/learning/variables/schottenstein.html | 2 +- api/learning/variables/vilna.html | 2 +- 41 files changed, 454 insertions(+), 277 deletions(-) diff --git a/api/learning/assets/icons.js b/api/learning/assets/icons.js index e88e8ca..3dfbd32 100644 --- a/api/learning/assets/icons.js +++ b/api/learning/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `""`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/api/learning/assets/icons.svg b/api/learning/assets/icons.svg index e371b8b..a19417d 100644 --- a/api/learning/assets/icons.svg +++ b/api/learning/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/api/learning/assets/main.js b/api/learning/assets/main.js index 7d7f77a..99097a0 100644 --- a/api/learning/assets/main.js +++ b/api/learning/assets/main.js @@ -1,9 +1,9 @@ "use strict"; window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; -"use strict";(()=>{var Ce=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),Ve(t,i,r,e)}function Ve(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?He(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function He(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",H="mouseup",J={x:0,y:0},me=!1,ne=!1,je=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",H="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var qe=new U;Object.defineProperty(window,"app",{value:qe});fe();we();})(); +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/api/learning/assets/style.css b/api/learning/assets/style.css index 9d619a6..178bfb0 100644 --- a/api/learning/assets/style.css +++ b/api/learning/assets/style.css @@ -4,11 +4,17 @@ --light-color-background-secondary: #eff0f1; --light-color-warning-text: #222; --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); --light-color-accent: #c5c7c9; --light-color-active-menu-item: var(--light-color-accent); --light-color-text: #222; --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + --light-color-link: #1f70c2; --light-color-focus-outline: #3584e4; @@ -22,16 +28,17 @@ --light-color-ts-function: #572be7; --light-color-ts-class: #1f70c2; --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-constructor: #4d7fff; + --light-color-ts-property: #ff984d; + --light-color-ts-method: #ff4db8; + --light-color-ts-reference: #ff4d82; --light-color-ts-call-signature: var(--light-color-ts-method); --light-color-ts-index-signature: var(--light-color-ts-property); --light-color-ts-constructor-signature: var(--light-color-ts-constructor); --light-color-ts-parameter: var(--light-color-ts-variable); /* type literal not included as links will never be generated to it */ --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-accessor: #ff4d4d; --light-color-ts-get-signature: var(--light-color-ts-accessor); --light-color-ts-set-signature: var(--light-color-ts-accessor); --light-color-ts-type-alias: #d51270; @@ -46,11 +53,17 @@ --dark-color-background-secondary: #1e2024; --dark-color-background-warning: #bebe00; --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); --dark-color-accent: #9096a2; --dark-color-active-menu-item: #5d5d6a; --dark-color-text: #f5f5f5; --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + --dark-color-link: #00aff4; --dark-color-focus-outline: #4c97f2; @@ -64,16 +77,17 @@ --dark-color-ts-function: #a280ff; --dark-color-ts-class: #8ac4ff; --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-constructor: #4d7fff; + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; --dark-color-ts-call-signature: var(--dark-color-ts-method); --dark-color-ts-index-signature: var(--dark-color-ts-property); --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); --dark-color-ts-parameter: var(--dark-color-ts-variable); /* type literal not included as links will never be generated to it */ --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-accessor: #ff4d4d; --dark-color-ts-get-signature: var(--dark-color-ts-accessor); --dark-color-ts-set-signature: var(--dark-color-ts-accessor); --dark-color-ts-type-alias: #ff6492; @@ -90,15 +104,22 @@ --color-background-secondary: var(--light-color-background-secondary); --color-background-warning: var(--light-color-background-warning); --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + --color-link: var(--light-color-link); --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -110,6 +131,7 @@ --color-ts-constructor: var(--light-color-ts-constructor); --color-ts-property: var(--light-color-ts-property); --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); --color-ts-call-signature: var(--light-color-ts-call-signature); --color-ts-index-signature: var(--light-color-ts-index-signature); --color-ts-constructor-signature: var( @@ -134,15 +156,22 @@ --color-background-secondary: var(--dark-color-background-secondary); --color-background-warning: var(--dark-color-background-warning); --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + --color-link: var(--dark-color-link); --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -154,6 +183,7 @@ --color-ts-constructor: var(--dark-color-ts-constructor); --color-ts-property: var(--dark-color-ts-property); --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); --color-ts-call-signature: var(--dark-color-ts-call-signature); --color-ts-index-signature: var(--dark-color-ts-index-signature); --color-ts-constructor-signature: var( @@ -190,10 +220,16 @@ body { --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + --color-link: var(--light-color-link); --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -205,6 +241,7 @@ body { --color-ts-constructor: var(--light-color-ts-constructor); --color-ts-property: var(--light-color-ts-property); --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); --color-ts-call-signature: var(--light-color-ts-call-signature); --color-ts-index-signature: var(--light-color-ts-index-signature); --color-ts-constructor-signature: var( @@ -232,10 +269,16 @@ body { --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + --color-link: var(--dark-color-link); --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -247,6 +290,7 @@ body { --color-ts-constructor: var(--dark-color-ts-constructor); --color-ts-property: var(--dark-color-ts-property); --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); --color-ts-call-signature: var(--dark-color-ts-call-signature); --color-ts-index-signature: var(--dark-color-ts-index-signature); --color-ts-constructor-signature: var( @@ -439,7 +483,6 @@ pre { pre { position: relative; - white-space: pre; white-space: pre-wrap; word-wrap: break-word; padding: 10px; @@ -860,6 +903,12 @@ a.tsd-index-link { margin-bottom: 0.75rem; } +.tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} .tsd-kind-icon { margin-right: 0.5rem; width: 1.25rem; @@ -867,10 +916,6 @@ a.tsd-index-link { min-width: 1.25rem; min-height: 1.25rem; } -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} .tsd-signature > .tsd-kind-icon { margin-right: 0.8rem; } @@ -1242,6 +1287,9 @@ img { .tsd-kind-method { color: var(--color-ts-method); } +.tsd-kind-reference { + color: var(--color-ts-reference); +} .tsd-kind-call-signature { color: var(--color-ts-call-signature); } @@ -1254,9 +1302,6 @@ img { .tsd-kind-parameter { color: var(--color-ts-parameter); } -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} .tsd-kind-type-parameter { color: var(--color-ts-type-parameter); } @@ -1435,7 +1480,7 @@ img { } .site-menu { - margin-top: 1rem 0; + margin-top: 1rem; } .page-menu, diff --git a/api/learning/classes/ChofetzChaimEvent.html b/api/learning/classes/ChofetzChaimEvent.html index 5f30bfa..85338f7 100644 --- a/api/learning/classes/ChofetzChaimEvent.html +++ b/api/learning/classes/ChofetzChaimEvent.html @@ -1,5 +1,5 @@ ChofetzChaimEvent | @hebcal/learning

Class ChofetzChaimEvent

Event wrapper around a Chofetz Chaim instance

-

Hierarchy

  • Event
    • ChofetzChaimEvent

Constructors

constructor +

Hierarchy

  • Event
    • ChofetzChaimEvent

Constructors

constructor

Properties

alarm? category date @@ -21,32 +21,44 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

reading

reading: ChofetzChaimReading

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

reading

reading: ChofetzChaimReading

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of reading

    +

render

  • render(locale?): string

  • Returns name of reading

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns name of reading

    +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns name of reading

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/DafPage.html b/api/learning/classes/DafPage.html index f164b2a..346e284 100644 --- a/api/learning/classes/DafPage.html +++ b/api/learning/classes/DafPage.html @@ -1,5 +1,5 @@ DafPage | @hebcal/learning

Class DafPage

Represents a tractate and page number

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

blatt name verses? @@ -7,6 +7,6 @@ getName render

Constructors

constructor

Properties

blatt

blatt: string | number

name

name: string

Optionalverses

verses?: string

Methods

getBlatt

getName

render

  • render(locale?): string

  • Formats (with translation) the dafyomi result as a string like "Pesachim 34"

    +

    Parameters

    • name: string
    • blatt: string | number

    Returns DafPage

Properties

blatt

blatt: string | number

name

name: string

Optionalverses

verses?: string

Methods

getBlatt

getName

render

  • render(locale?): string

  • Formats (with translation) the dafyomi result as a string like "Pesachim 34"

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/DafPageEvent.html b/api/learning/classes/DafPageEvent.html index a4df270..a3471b7 100644 --- a/api/learning/classes/DafPageEvent.html +++ b/api/learning/classes/DafPageEvent.html @@ -1,5 +1,5 @@ DafPageEvent | @hebcal/learning

Class DafPageEvent

Event wrapper around a DafPage instance

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

alarm? category? daf @@ -21,31 +21,43 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Optionalcategory

category?: string

daf

daf: DafPage

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

Optionalcategory

category?: string

daf

daf: DafPage

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

    +

render

  • render(locale?): string

  • Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

    +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/DafWeeklyEvent.html b/api/learning/classes/DafWeeklyEvent.html index efe084d..e009d48 100644 --- a/api/learning/classes/DafWeeklyEvent.html +++ b/api/learning/classes/DafWeeklyEvent.html @@ -1,5 +1,5 @@ DafWeeklyEvent | @hebcal/learning

Class DafWeeklyEvent

Event wrapper around a daily weekly

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

alarm? category? daf @@ -21,31 +21,43 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Optionalcategory

category?: string

daf

daf: DafPage

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

Optionalcategory

category?: string

daf

daf: DafPage

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

    +

render

  • render(locale?): string

  • Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

    +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/DafYomi.html b/api/learning/classes/DafYomi.html index 004410a..b6b6441 100644 --- a/api/learning/classes/DafYomi.html +++ b/api/learning/classes/DafYomi.html @@ -1,5 +1,5 @@ DafYomi | @hebcal/learning

Class DafYomi

Returns the Daf Yomi for given date

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

blatt name verses? @@ -8,6 +8,6 @@ render

Constructors

constructor

Properties

blatt

blatt: string | number

name

name: string

Optionalverses

verses?: string

Methods

getBlatt

getName

render

  • render(locale?): string

  • Formats (with translation) the dafyomi result as a string like "Pesachim 34"

    +

Returns DafYomi

Properties

blatt

blatt: string | number

name

name: string

Optionalverses

verses?: string

Methods

getBlatt

getName

render

  • render(locale?): string

  • Formats (with translation) the dafyomi result as a string like "Pesachim 34"

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/DafYomiEvent.html b/api/learning/classes/DafYomiEvent.html index 9571769..a5e2a1f 100644 --- a/api/learning/classes/DafYomiEvent.html +++ b/api/learning/classes/DafYomiEvent.html @@ -1,5 +1,5 @@ DafYomiEvent | @hebcal/learning

Class DafYomiEvent

Event wrapper around a DafYomi instance

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

alarm? category? daf @@ -21,31 +21,43 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Optionalcategory

category?: string

daf

daf: DafPage

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

Optionalcategory

category?: string

daf

daf: DafPage

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

    +

render

  • render(locale?): string

  • Returns Daf Yomi name including the 'Daf Yomi: ' prefix (e.g. "Daf Yomi: Pesachim 107").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

    +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns Daf Yomi name without the 'Daf Yomi: ' prefix (e.g. "Pesachim 107").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/DailyRambamEvent.html b/api/learning/classes/DailyRambamEvent.html index acb0966..a3f9f67 100644 --- a/api/learning/classes/DailyRambamEvent.html +++ b/api/learning/classes/DailyRambamEvent.html @@ -1,5 +1,5 @@ DailyRambamEvent | @hebcal/learning

Class DailyRambamEvent

Event wrapper around a Daily Rambam instance

-

Hierarchy

  • Event
    • DailyRambamEvent

Constructors

constructor +

Hierarchy

  • Event
    • DailyRambamEvent

Constructors

constructor

Properties

alarm? category date @@ -21,33 +21,45 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

reading

reading: RambamReading

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

reading

reading: RambamReading

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of reading

    +

render

  • render(locale?): string

  • Returns name of reading

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/MishnaYomiEvent.html b/api/learning/classes/MishnaYomiEvent.html index c15326d..b21b376 100644 --- a/api/learning/classes/MishnaYomiEvent.html +++ b/api/learning/classes/MishnaYomiEvent.html @@ -1,5 +1,5 @@ MishnaYomiEvent | @hebcal/learning

Class MishnaYomiEvent

Event wrapper around a Mishna Yomi instance

-

Hierarchy

  • Event
    • MishnaYomiEvent

Constructors

constructor +

Hierarchy

  • Event
    • MishnaYomiEvent

Constructors

constructor

Properties

alarm? category date @@ -21,33 +21,45 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

mishnaYomi

mishnaYomi: MishnaYomi[]

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

mishnaYomi

mishnaYomi: MishnaYomi[]

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").

    +

render

  • render(locale?): string

  • Returns Mishna Yomi name (e.g. "Bava Metzia 10:5-6" or "Berakhot 9:5-Peah 1:1").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/MishnaYomiIndex.html b/api/learning/classes/MishnaYomiIndex.html index e554350..acd0e6c 100644 --- a/api/learning/classes/MishnaYomiIndex.html +++ b/api/learning/classes/MishnaYomiIndex.html @@ -1,7 +1,7 @@ MishnaYomiIndex | @hebcal/learning

Class MishnaYomiIndex

A program of daily learning in which participants study two Mishnahs each day in order to finish the entire Mishnah in ~6 years.

-

Constructors

constructor +

Constructors

constructor

Methods

lookup

Constructors

constructor

Methods

lookup

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file +

Returns MishnaYomiIndex

Methods

lookup

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/learning/classes/NachYomiEvent.html b/api/learning/classes/NachYomiEvent.html index b242685..fe96c44 100644 --- a/api/learning/classes/NachYomiEvent.html +++ b/api/learning/classes/NachYomiEvent.html @@ -1,5 +1,5 @@ NachYomiEvent | @hebcal/learning

Class NachYomiEvent

Event wrapper around a Nach Yomi instance

-

Hierarchy

  • Event
    • NachYomiEvent

Constructors

constructor +

Hierarchy

  • Event
    • NachYomiEvent

Constructors

constructor

Properties

alarm? category date @@ -21,33 +21,45 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

nachYomi

nachYomi: NachYomi

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

nachYomi

nachYomi: NachYomi

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of tractate and page (e.g. "Beitzah 21").

    +

render

  • render(locale?): string

  • Returns name of tractate and page (e.g. "Beitzah 21").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/NachYomiIndex.html b/api/learning/classes/NachYomiIndex.html index c95256b..571fbac 100644 --- a/api/learning/classes/NachYomiIndex.html +++ b/api/learning/classes/NachYomiIndex.html @@ -1,7 +1,7 @@ NachYomiIndex | @hebcal/learning

Class NachYomiIndex

A daily regimen of learning the books of Nevi'im (Prophets) and Ketuvim (Writings).

-

Constructors

constructor +

Constructors

constructor

Methods

lookup

Constructors

constructor

Methods

lookup

Settings

Member Visibility

On This Page

Constructors
Methods
\ No newline at end of file +

Returns NachYomiIndex

Methods

lookup

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/api/learning/classes/PirkeiAvotSummerEvent.html b/api/learning/classes/PirkeiAvotSummerEvent.html index 0de8c65..72ffb8c 100644 --- a/api/learning/classes/PirkeiAvotSummerEvent.html +++ b/api/learning/classes/PirkeiAvotSummerEvent.html @@ -1,6 +1,6 @@ PirkeiAvotSummerEvent | @hebcal/learning

Class PirkeiAvotSummerEvent

Event wrapper for Pirkei Avot being studied on Shabbat between Pesach and Rosh Hashana

-

Hierarchy

  • Event
    • PirkeiAvotSummerEvent

Constructors

constructor +

Hierarchy

  • Event
    • PirkeiAvotSummerEvent

Constructors

constructor

Properties

alarm? category date @@ -22,33 +22,45 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

reading

reading: number[]

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

reading

reading: number[]

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of reading

    +

render

  • render(locale?): string

  • Returns name of reading

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/PsalmsEvent.html b/api/learning/classes/PsalmsEvent.html index 7aa7edf..7bdb08b 100644 --- a/api/learning/classes/PsalmsEvent.html +++ b/api/learning/classes/PsalmsEvent.html @@ -1,5 +1,5 @@ PsalmsEvent | @hebcal/learning

Class PsalmsEvent

Event wrapper around a daily Psalms / Tehillim

-

Hierarchy

  • Event
    • PsalmsEvent

Constructors

constructor +

Hierarchy

  • Event
    • PsalmsEvent

Constructors

constructor

Properties

alarm? category date @@ -21,34 +21,46 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

reading

reading: PsalmBeginEnd

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

reading

reading: PsalmBeginEnd

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of reading

    +

render

  • render(locale?): string

  • Returns name of reading

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/ShemiratHaLashonEvent.html b/api/learning/classes/ShemiratHaLashonEvent.html index aa1aa53..b29b41b 100644 --- a/api/learning/classes/ShemiratHaLashonEvent.html +++ b/api/learning/classes/ShemiratHaLashonEvent.html @@ -1,5 +1,5 @@ ShemiratHaLashonEvent | @hebcal/learning

Class ShemiratHaLashonEvent

Event wrapper around a Sefer Shemirat HaLashon instance

-

Hierarchy

  • Event
    • ShemiratHaLashonEvent

Constructors

constructor +

Hierarchy

  • Event
    • ShemiratHaLashonEvent

Constructors

constructor

Properties

alarm? category date @@ -21,34 +21,46 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

memo

memo: string

reading

reading: any

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

memo

memo: string

Optional longer description or memo text

+

reading

reading: any

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of reading

    +

render

  • render(locale?): string

  • Returns name of reading

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/classes/YerushalmiYomiEvent.html b/api/learning/classes/YerushalmiYomiEvent.html index ed2dcf3..40fe6a8 100644 --- a/api/learning/classes/YerushalmiYomiEvent.html +++ b/api/learning/classes/YerushalmiYomiEvent.html @@ -1,5 +1,5 @@ YerushalmiYomiEvent | @hebcal/learning

Class YerushalmiYomiEvent

Event wrapper around a Yerushalmi Yomi result

-

Hierarchy

  • Event
    • YerushalmiYomiEvent

Constructors

constructor +

Hierarchy

  • Event
    • YerushalmiYomiEvent

Constructors

constructor

Properties

alarm? category daf @@ -21,31 +21,43 @@ render renderBrief url -

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

category

category: string

daf

daf: YerushalmiReading

Readonlydate

date: HDate

Readonlydesc

desc: string

Optionalemoji

emoji?: string

Readonlymask

mask: number

Optionalmemo

memo?: string

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, -the HolidayEvent class supports +

Constructors

constructor

Properties

Optionalalarm

alarm?: string | boolean | Date

Alarms are used by iCalendar feeds

+

category

category: string

daf

daf: YerushalmiReading

Readonlydate

date: HDate

Hebrew date of this event

+

Readonlydesc

desc: string

Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

+

Optionalemoji

emoji?: string

Optional emoji character such as ✡️, 🕯️, 🕎, 🕍, 🌒

+

Readonlymask

mask: number

Bitmask of optional event flags. See flags

+

Optionalmemo

memo?: string

Optional longer description or memo text

+

Methods

basename

  • basename(): string

  • Returns a simplified (untranslated) description for this event. For example, +the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

    -

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    -

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    -

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    -

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated description of this event

    -

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    -

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    -

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    -

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
+

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

getCategories

  • getCategories(): string[]

  • Returns a list of event categories

    +

    Returns string[]

getDate

  • getDate(): HDate

  • Hebrew date of this event

    +

    Returns HDate

getDesc

  • getDesc(): string

  • Untranslated title of this event. Note that these description +strings are always in English and will remain stable across releases. +To get the title of the event in another language, use the +render() method.

    +

    Returns string

getEmoji

  • getEmoji(): null | string

  • Optional holiday-specific Emoji or null.

    +

    Returns null | string

getFlags

  • getFlags(): number

  • Bitmask of optional event flags. See flags

    +

    Returns number

observedIn

  • observedIn(il): boolean

  • Is this event observed in Israel/Diaspora?

    +

    Parameters

    • il: boolean

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedIn(false); // true
    ev1.observedIn(true); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedIn(false); // true
    ev2.observedIn(true); // true
    -

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
+

observedInDiaspora

  • observedInDiaspora(): boolean

  • Is this event observed in the Diaspora?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInDiaspora(); // true
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInDiaspora(); // true
    -

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    -

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
+

observedInIsrael

  • observedInIsrael(): boolean

  • Is this event observed in Israel?

    +

    Returns boolean

    Example

    const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
    ev1.observedInIsrael(); // false
    const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
    ev2.observedInIsrael(); // true
    -

render

  • render(locale?): string

  • Returns name of tractate and page (e.g. "Yerushalmi Beitzah 21").

    +

render

  • render(locale?): string

  • Returns name of tractate and page (e.g. "Yerushalmi Beitzah 21").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns name of tractate and page (e.g. "Beitzah 21").

    +

Returns string

renderBrief

  • renderBrief(locale?): string

  • Returns name of tractate and page (e.g. "Beitzah 21").

    Parameters

    • Optionallocale: string

      Optional locale name (defaults to active locale).

      -

    Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
\ No newline at end of file +

Returns string

url

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/learning/functions/chofetzChaim.html b/api/learning/functions/chofetzChaim.html index e114313..a2f4918 100644 --- a/api/learning/functions/chofetzChaim.html +++ b/api/learning/functions/chofetzChaim.html @@ -1,2 +1,2 @@ chofetzChaim | @hebcal/learning

Function chofetzChaim

Settings

Member Visibility
\ No newline at end of file +

Parameters

  • hdate: HDate

Returns ChofetzChaimReading

Settings

Member Visibility
diff --git a/api/learning/functions/dafWeekly.html b/api/learning/functions/dafWeekly.html index 8abe681..07c9e68 100644 --- a/api/learning/functions/dafWeekly.html +++ b/api/learning/functions/dafWeekly.html @@ -1,3 +1,3 @@ dafWeekly | @hebcal/learning

Function dafWeekly

Settings

Member Visibility
\ No newline at end of file +

Returns DafPage

Settings

Member Visibility
diff --git a/api/learning/functions/dailyPsalms.html b/api/learning/functions/dailyPsalms.html index f6c8fa5..8683831 100644 --- a/api/learning/functions/dailyPsalms.html +++ b/api/learning/functions/dailyPsalms.html @@ -1,2 +1,2 @@ dailyPsalms | @hebcal/learning

Function dailyPsalms

Settings

Member Visibility
\ No newline at end of file +

Parameters

  • date: number | Date | HDate

Returns PsalmBeginEnd

Settings

Member Visibility
diff --git a/api/learning/functions/dailyRambam1.html b/api/learning/functions/dailyRambam1.html index 87275c9..8224ed4 100644 --- a/api/learning/functions/dailyRambam1.html +++ b/api/learning/functions/dailyRambam1.html @@ -1,2 +1,2 @@ dailyRambam1 | @hebcal/learning

Function dailyRambam1

Settings

Member Visibility
\ No newline at end of file +

Parameters

  • date: number | Date | HDate

Returns RambamReading

Settings

Member Visibility
diff --git a/api/learning/functions/pirkeiAvot.html b/api/learning/functions/pirkeiAvot.html index ef111b0..83ff7b7 100644 --- a/api/learning/functions/pirkeiAvot.html +++ b/api/learning/functions/pirkeiAvot.html @@ -5,8 +5,8 @@ on each Shabbat of the summer, from Passover to Rosh Hashanah, the entire cycle repeating a few times with doubling of chapters at the end if there are not a perfect multiple of six weeks" -https://en.wikipedia.org/wiki/Pirkei_Avot#Study_of_the_work

+https://en.wikipedia.org/wiki/Pirkei_Avot#Study_of_the_work

returns array (since it can return 2 chapters) or undefined if there is no Pirkei Avot on that day optimized for diaspora and il feel free to modify whatever you want, i am sure this task can be done in different ways and orders

-

Parameters

  • dt: Date | HDate
  • il: boolean

Returns number[] | null

Settings

Member Visibility
\ No newline at end of file +

Parameters

  • dt: Date | HDate
  • il: boolean

Returns number[] | null

Settings

Member Visibility
diff --git a/api/learning/functions/shemiratHaLashon.html b/api/learning/functions/shemiratHaLashon.html index 9585b75..7906550 100644 --- a/api/learning/functions/shemiratHaLashon.html +++ b/api/learning/functions/shemiratHaLashon.html @@ -1,2 +1,2 @@ shemiratHaLashon | @hebcal/learning

Function shemiratHaLashon

Settings

Member Visibility
\ No newline at end of file +

Parameters

  • hdate: HDate

Returns ShemiratHaLashonReading

Settings

Member Visibility
diff --git a/api/learning/functions/yerushalmiYomi.html b/api/learning/functions/yerushalmiYomi.html index 69b12e9..b367097 100644 --- a/api/learning/functions/yerushalmiYomi.html +++ b/api/learning/functions/yerushalmiYomi.html @@ -11,4 +11,4 @@ 14 November 2022 for Schottenstein).

Parameters

  • date: number | Date | HDate

    Hebrew or Gregorian date

  • config: any

    either vilna or schottenstein

    -

Returns YerushalmiReading | null

Settings

Member Visibility
\ No newline at end of file +

Returns YerushalmiReading | null

Settings

Member Visibility
diff --git a/api/learning/hierarchy.html b/api/learning/hierarchy.html index 77a64a8..6229d93 100644 --- a/api/learning/hierarchy.html +++ b/api/learning/hierarchy.html @@ -1 +1 @@ -@hebcal/learning

@hebcal/learning

Class Hierarchy

Settings

Member Visibility
\ No newline at end of file +@hebcal/learning

@hebcal/learning

Class Hierarchy

Settings

Member Visibility
diff --git a/api/learning/index.html b/api/learning/index.html index cdb3337..add8c29 100644 --- a/api/learning/index.html +++ b/api/learning/index.html @@ -1,5 +1,5 @@ -@hebcal/learning

@hebcal/learning

hebcal-learning

Javascript Daily Learning Schedules

-

Build Status

+@hebcal/learning

@hebcal/learning

hebcal-learning

Javascript Daily Learning Schedules

+

Build Status

Supports several learning schedules

  • Daf Yomi (Babylonian Talmud / Bavli) - dafYomi
    • @@ -34,4 +34,4 @@

    Synopsis

    import {HDate, DailyLearning} from '@hebcal/core';
    import '@hebcal/learning';

    const dt = new Date();
    const hd = new HDate(dt);
    const ev = DailyLearning.lookup('dafYomi', hd);
    console.log(dt.toLocaleDateString(), hd.toString(), ev.render('en'));
    -

    API Documentation

Settings

Member Visibility

On This Page

hebcal-learning
\ No newline at end of file +

API Documentation

Settings

Member Visibility

On This Page

hebcal-learning
diff --git a/api/learning/modules.html b/api/learning/modules.html index e4c29a5..18f7a88 100644 --- a/api/learning/modules.html +++ b/api/learning/modules.html @@ -1,4 +1,4 @@ -@hebcal/learning

@hebcal/learning

Index

Classes

ChofetzChaimEvent +@hebcal/learning

@hebcal/learning

Index

Classes

ChofetzChaimEvent DafPage DafPageEvent DafWeeklyEvent @@ -32,4 +32,4 @@ pirkeiAvot shemiratHaLashon yerushalmiYomi -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
diff --git a/api/learning/types/ChofetzChaimReading.html b/api/learning/types/ChofetzChaimReading.html index f37f962..5df904c 100644 --- a/api/learning/types/ChofetzChaimReading.html +++ b/api/learning/types/ChofetzChaimReading.html @@ -1 +1 @@ -ChofetzChaimReading | @hebcal/learning

Type Alias ChofetzChaimReading

ChofetzChaimReading: {
    b: string | number;
    e: string | number | number[];
    k: string;
    textBegin?: string;
    textEnd?: string;
}

Settings

Member Visibility
\ No newline at end of file +ChofetzChaimReading | @hebcal/learning

Type Alias ChofetzChaimReading

ChofetzChaimReading: {
    b: string | number;
    e: string | number | number[];
    k: string;
    textBegin?: string;
    textEnd?: string;
}

Settings

Member Visibility
diff --git a/api/learning/types/MishnaYomi.html b/api/learning/types/MishnaYomi.html index 8e0a590..f24c354 100644 --- a/api/learning/types/MishnaYomi.html +++ b/api/learning/types/MishnaYomi.html @@ -1,4 +1,4 @@ MishnaYomi | @hebcal/learning

Type Alias MishnaYomi

MishnaYomi: {
    k: string;
    v: string;
}

Describes a mishna to be read

Type declaration

  • k: string

    tractate name in Sephardic transliteration (e.g. "Berakhot", "Moed Katan")

  • v: string

    verse (e.g. "2:1")

    -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
diff --git a/api/learning/types/NachYomi.html b/api/learning/types/NachYomi.html index 0985777..a078091 100644 --- a/api/learning/types/NachYomi.html +++ b/api/learning/types/NachYomi.html @@ -1,4 +1,4 @@ NachYomi | @hebcal/learning

Type Alias NachYomi

NachYomi: {
    k: string;
    v: number;
}

Describes a chapter to be read

Type declaration

  • k: string

    book name in English transliteration (e.g. "Joshua", "Song of Songs")

  • v: number

    chapter number (e.g. 2)

    -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
diff --git a/api/learning/types/PsalmBeginEnd.html b/api/learning/types/PsalmBeginEnd.html index 77feb77..ad49c76 100644 --- a/api/learning/types/PsalmBeginEnd.html +++ b/api/learning/types/PsalmBeginEnd.html @@ -1 +1 @@ -PsalmBeginEnd | @hebcal/learning

Type Alias PsalmBeginEnd

PsalmBeginEnd: [number | string, number | string]

Settings

Member Visibility
\ No newline at end of file +PsalmBeginEnd | @hebcal/learning

Type Alias PsalmBeginEnd

PsalmBeginEnd: [number | string, number | string]

Settings

Member Visibility
diff --git a/api/learning/types/RambamReading.html b/api/learning/types/RambamReading.html index 50f6a52..dd2ff4c 100644 --- a/api/learning/types/RambamReading.html +++ b/api/learning/types/RambamReading.html @@ -1 +1 @@ -RambamReading | @hebcal/learning

Type Alias RambamReading

RambamReading: {
    name: string;
    perek: number | string;
}

Settings

Member Visibility
\ No newline at end of file +RambamReading | @hebcal/learning

Type Alias RambamReading

RambamReading: {
    name: string;
    perek: number | string;
}

Settings

Member Visibility
diff --git a/api/learning/types/ShemiratHaLashonReading.html b/api/learning/types/ShemiratHaLashonReading.html index cc6e01d..897d23a 100644 --- a/api/learning/types/ShemiratHaLashonReading.html +++ b/api/learning/types/ShemiratHaLashonReading.html @@ -1 +1 @@ -ShemiratHaLashonReading | @hebcal/learning

Type Alias ShemiratHaLashonReading

ShemiratHaLashonReading: {
    b: number | string;
    bk: number;
    e: number | string;
    k: string;
}

Settings

Member Visibility
\ No newline at end of file +ShemiratHaLashonReading | @hebcal/learning

Type Alias ShemiratHaLashonReading

ShemiratHaLashonReading: {
    b: number | string;
    bk: number;
    e: number | string;
    k: string;
}

Settings

Member Visibility
diff --git a/api/learning/types/YerushalmiReading.html b/api/learning/types/YerushalmiReading.html index 3c6ae11..937e74b 100644 --- a/api/learning/types/YerushalmiReading.html +++ b/api/learning/types/YerushalmiReading.html @@ -1 +1 @@ -YerushalmiReading | @hebcal/learning

Type Alias YerushalmiReading

YerushalmiReading: {
    blatt: number;
    ed: string;
    name: string;
}

Settings

Member Visibility
\ No newline at end of file +YerushalmiReading | @hebcal/learning

Type Alias YerushalmiReading

YerushalmiReading: {
    blatt: number;
    ed: string;
    name: string;
}

Settings

Member Visibility
diff --git a/api/learning/variables/dafWeeklyStart.html b/api/learning/variables/dafWeeklyStart.html index 8432e1f..cff1cba 100644 --- a/api/learning/variables/dafWeeklyStart.html +++ b/api/learning/variables/dafWeeklyStart.html @@ -1 +1 @@ -dafWeeklyStart | @hebcal/learning

Variable dafWeeklyStartConst

dafWeeklyStart: number = ...

Settings

Member Visibility
\ No newline at end of file +dafWeeklyStart | @hebcal/learning

Variable dafWeeklyStartConst

dafWeeklyStart: number = ...

Settings

Member Visibility
diff --git a/api/learning/variables/mishnaYomiStart.html b/api/learning/variables/mishnaYomiStart.html index b514710..5d401ce 100644 --- a/api/learning/variables/mishnaYomiStart.html +++ b/api/learning/variables/mishnaYomiStart.html @@ -1 +1 @@ -mishnaYomiStart | @hebcal/learning

Variable mishnaYomiStartConst

mishnaYomiStart: number = ...

Settings

Member Visibility
\ No newline at end of file +mishnaYomiStart | @hebcal/learning

Variable mishnaYomiStartConst

mishnaYomiStart: number = ...

Settings

Member Visibility
diff --git a/api/learning/variables/nachYomiStart.html b/api/learning/variables/nachYomiStart.html index f968504..33c0e5d 100644 --- a/api/learning/variables/nachYomiStart.html +++ b/api/learning/variables/nachYomiStart.html @@ -1 +1 @@ -nachYomiStart | @hebcal/learning

Variable nachYomiStartConst

nachYomiStart: number = ...

Settings

Member Visibility
\ No newline at end of file +nachYomiStart | @hebcal/learning

Variable nachYomiStartConst

nachYomiStart: number = ...

Settings

Member Visibility
diff --git a/api/learning/variables/schottenstein.html b/api/learning/variables/schottenstein.html index de8d36f..9d0e75a 100644 --- a/api/learning/variables/schottenstein.html +++ b/api/learning/variables/schottenstein.html @@ -1,2 +1,2 @@ schottenstein | @hebcal/learning

Variable schottensteinConst Readonly

schottenstein: {
    ed: string;
    shas: (string | number)[][];
    skipYK9Av: boolean;
    startAbs: number;
    startDate: Date;
} = ...

Yerushalmi Yomi configuration for Schottenstein Edition

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
diff --git a/api/learning/variables/vilna.html b/api/learning/variables/vilna.html index 3a8e528..be9f202 100644 --- a/api/learning/variables/vilna.html +++ b/api/learning/variables/vilna.html @@ -1,2 +1,2 @@ vilna | @hebcal/learning

Variable vilnaConst Readonly

vilna: {
    ed: string;
    shas: (string | number)[][];
    skipYK9Av: boolean;
    startAbs: number;
    startDate: Date;
} = ...

Yerushalmi Yomi configuration for Vilna Edition

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility