From c11e6bb2920d6a0a4f5710a19385bdc65bbd9968 Mon Sep 17 00:00:00 2001 From: "Michael J. Radwin" Date: Fri, 27 Dec 2024 10:41:11 -0800 Subject: [PATCH] sync with learning 6.x --- api/learning/assets/hierarchy.js | 1 + api/learning/assets/icons.js | 2 +- api/learning/assets/icons.svg | 2 +- api/learning/assets/main.js | 10 +- api/learning/assets/navigation.js | 2 +- api/learning/assets/search.js | 2 +- api/learning/assets/style.css | 2693 +++++++++-------- api/learning/classes/ChofetzChaimEvent.html | 72 +- api/learning/classes/DafPage.html | 14 +- api/learning/classes/DafPageEvent.html | 70 +- api/learning/classes/DafWeeklyEvent.html | 70 +- api/learning/classes/DafYomi.html | 16 +- api/learning/classes/DafYomiEvent.html | 70 +- api/learning/classes/DailyRambamEvent.html | 70 +- api/learning/classes/MishnaYomiEvent.html | 72 +- api/learning/classes/MishnaYomiIndex.html | 10 +- api/learning/classes/NachYomiEvent.html | 72 +- api/learning/classes/NachYomiIndex.html | 10 +- .../classes/PirkeiAvotSummerEvent.html | 70 +- api/learning/classes/PsalmsEvent.html | 72 +- .../classes/ShemiratHaLashonEvent.html | 72 +- api/learning/classes/YerushalmiYomiEvent.html | 70 +- api/learning/functions/chofetzChaim.html | 4 +- api/learning/functions/dafWeekly.html | 6 +- api/learning/functions/dailyPsalms.html | 4 +- api/learning/functions/dailyRambam1.html | 4 +- api/learning/functions/pirkeiAvot.html | 6 +- api/learning/functions/shemiratHaLashon.html | 4 +- api/learning/functions/yerushalmiYomi.html | 6 +- api/learning/hierarchy.html | 2 +- api/learning/index.html | 10 +- api/learning/modules.html | 36 +- api/learning/types/ChofetzChaimReading.html | 2 +- api/learning/types/MishnaYomi.html | 8 +- api/learning/types/NachYomi.html | 8 +- 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 | 4 +- api/learning/variables/vilna.html | 4 +- 44 files changed, 1874 insertions(+), 1790 deletions(-) create mode 100644 api/learning/assets/hierarchy.js diff --git a/api/learning/assets/hierarchy.js b/api/learning/assets/hierarchy.js new file mode 100644 index 0000000..6f0c680 --- /dev/null +++ b/api/learning/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "eJyV0MELgjAUx/H/5Xd+FROVtnPdu0WIB9FninOCW0GI/3uoEZUH7bLD47v3GevQNo2zUJEgEcaElnPNqSsbY6E6iOEwSc1QOCT5KbkyCFVpMijh7Qm3VkMh1Ym1bHevZFu4WoOmMRSczTbDnc00IKRFqbOWDVTk+SLuCSKcS8c7G7eCG7t/TCEleUEwulJ+w2fmSj/W0B/lAt4TPP/nKy9NXS4AQ7JicxDMN695/7tbMvr+Ca5Zsbo=" \ No newline at end of file diff --git a/api/learning/assets/icons.js b/api/learning/assets/icons.js index 3dfbd32..58882d7 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 = `MMNEPVFCICPMFPCPTTAAATR`; + 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 a19417d..50ad579 100644 --- a/api/learning/assets/icons.svg +++ b/api/learning/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ 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 99097a0..4f59cd9 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 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();})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse"}; +"use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(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,c],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[c+1]*i[d+1],c+=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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,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 de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){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){ce.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&&!ze(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 ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function H(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await H(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.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",()=>{fe(e,t)}),fe(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",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(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(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(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=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ye(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=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(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 Je(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),re(e)}}function ye(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(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var A="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Xe=!0,A="touchstart",Ee="touchmove",B="touchend");document.addEventListener(A,t=>{ie=!0,D=!1;let e=A=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=A=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(A,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,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 se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var Z=class extends I{key;value;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()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.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 oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await H(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(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='',ke(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 c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=ee+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}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await H(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(Oe(e,i,n))}function Oe(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=Oe(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(K,".tsd-accordion");G(Z,".tsd-filter-item input[type=checkbox]");var _e=document.getElementById("tsd-theme");_e&&Se(_e);var nt=new J;Object.defineProperty(window,"app",{value:nt});ve();Ce();Pe();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/api/learning/assets/navigation.js b/api/learning/assets/navigation.js index 335ae70..4151cb8 100644 --- a/api/learning/assets/navigation.js +++ b/api/learning/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE43UXU/DIBQG4P/C9eLc/N6dX4kmapbtwhjjxbE9G2RAl8IWq/G/G/fRFgaH3vZ9eUJ6gPcfZvHLshG75cUM7fctB6Hu16gt67ElWM5GLJNgDJr+QeWIWyVZjy2EztloMLz87dXeHczGMMdDZRd0WBvZRjtNKK+IC1nFnVaekN4KJYLEf9BhbXwPdUorQlYTUJ8QG47foLRnYbgGYlteoZv1qHP8oqxNgbJeIOPErpy4ixPZkRNTzliUCxTX68JOV0phGdlXsEa6BqQyMa0JKWPKUYkS7AM8geGFjmjBGuW+YbkyHKQSxCQCJcpsPxwThFzoeWPaaum9LbuKKw6Pry4GZ8PgyfOxJkkZ+6PgC/vvqfWbYd3gXOh7nfuIE6ak7dWN/B0nTEn+yCNmpJbSm9FH3INCSsz37/DUQtk6bGsoBXxKNH234XonbUrVg49aXoXA9O4MRCmnQEAm44W1qI1FoUOQUyCgtZAaQsAmIBZmrdvVrJ+tdGZFoU2/nbvM+WloUiGjDklAyGr7wIWJOk4h2xsxiCq7nGCW9asdQpqUIIx3hUKQ3yG4ynlVQ5jbOKA+/gCIjPmqzwkAAA==" \ No newline at end of file +window.navigationData = "eJyN1F1PwyAUBuD/wvXi3PzenV+JJmqW7cIY48WxPRtkQJfCFqvxvxv30RYGh972fXlCeoD3H2bxy7IRu+XFDO33LQeh7teoLeuxJVjORiyTYAya/kHliFslWY8thM7ZaDC8/O3V3h3MxjDHQ2UXdFgb2UY7TSiviAtZxZ1WnpDeCiWCxH/QYW18D3VKK0JWE1CfEBuO36C0Z2G4BmJbXqGb9ahz/KKsTYGyXiDjxK6cuIsT2ZETU85YlAsU1+vCTldKYRnZV7BGugakMjGtCSljylGJEuwDPIHhhY5owRrlvmG5MhykEsQkAiXKbD8cE4Rc6Hlj2mrpvS27iisOj68uBmfD4MnzsSZJGfuj4Av776n1m2Hd4Fzoe537iBOmpO3VjfwdJ0xJ/sgjZqSW0pvRR9yDQkrM9+/w1ELZOmxrKAV8SjR9t+F6J21K1YOPWl6FwPTuDEQpp0BAJuOFtaiNRaFDkFMgoLWQGkLAJiAWZq3b1ayfrXRmRaFNv527zPlpaFIhow5JQMhq+8CFiTpOIdsbMYgqu5xglvWrHUKalCCMd4VCkN8huMp5VUOY2zigPv4ABXlaBQ==" \ No newline at end of file diff --git a/api/learning/assets/search.js b/api/learning/assets/search.js index 43c721b..e359d67 100644 --- a/api/learning/assets/search.js +++ b/api/learning/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61dbW/jNhL+L+pXn6vhi17yre0VuMNdi6IF7lAEi0JJtBsjjh3Y3rS5xf73gyjJ4nBmKMrxp92VyHlG5DMvnJG1X7LD/s9jdnP7JXva7B6yG1DVKts1z212k/29+fhL86nNVtnnwza7ye63zfHYHr8drq8fT8/bbDVezm6y7OtqlGNBneXc73fH0+Hz/Wl/iMr6Bg/05K6yl+bQ7k6eUhMU5MqcsdwfUZBhxEXS77bN6RQXPw65SP5re+jmRAHOY1IRVG6mPf3Unr6ffwhv1KUoP89uxDToIoxDu3toZwh1HpO8G5T+P752gwUYd/OahjAJXGINvY4CqR6ajwlo/ajLUe6bU/tpf3hLebBp6CK8BdvvoaVxIAHr+8OmTVlJPPpy1A5nHq0ftWzfPJL/tDk+7prf988bnufB/atQnZOZxPZQWYGKz+dhadBo/LuQRSPgH3nODmTUFFNgMWesIRGRoyYLF2NnItan9vRDv1AbJjSyqOGUxXvqGcjPzf2jbB7o7lWMg0pMMg2sppgc9YNSQL2x70AUDYJ7zDlzkBBTjIHBmzGFJDTOEBiomBkk4cSNgEFMMwFxDz0D+OFx/7E9/e+Hx2bzzBsBGXEVQ+ClJhkDVVmg56FtHja7T6nY0/B34opmIT30nGnEkJNTGfGp5/OZhfjLoN+PypmpABkz1WS8uLkKyGkmG9ehLsEq1nR/Dah+ensJVBlGRI23sFYXZ/l//NFJSRT5zXn0/IONygrm87QMcv20BHQ96CmVABZi310Re+FSrxct9gz2qf3r9H37abNbqIM/75q6/Lh7uECTftY79Cg8J+6NP6vy8fPu/rTZ747f+rejNhXUHP7btk/bN7Hq4N2+Vt0hFJlaefA1vcgRcthpXlBET6l8EMyw9nE6Pvxtc/zbZvfYHjan9mE5cqwaQpebi+4X6ZBYISEaMHH2Wvhi1URQguYZ79dEqKQQDcLYfxFygfjXj2Hcw/le1Iq1osJ+OzWHyTW8NodNc7dtPYluwBKXw54Jh+vXcjJnWanexSm1sMo/gZAq/8xextDEqv8ER6v+78CTuwATINMFWIaY3BWYMNmuwPtQpS4BAiVdgndgyk5xglzuDcPdpOYlxvPrVo+IwCXWdmE0WVZWScGazRouKnYIyCkZQ4C3MF+4vErGbOcFuULi3oqRmt3gxXH6oloaRV8Yo3lUfEz+ifYL+hPFdOO9h+JA0txZ2NMo8QjMA0ROvt6E+GHrNQ3p9TIkthX1z91D+1ek1O/uX7kVNclc2IrqlRU4vd3vnz6/pMGexy5F9JLEqZUlZYnBiOgqhobyc9g/6BkxXn6vkSA5cyZy1iXRQDjhEfM4D19mHCyKbBoRFKYFxZsFunvVFtRCk8BqLjMIBnLGHCQ0zxjGFpZkCuh+8nnpl83hqd1897o//fb5+bk98JkdO+oquyNLTtolXv2F/ZGIDnM9kkX4YmIUW4S5XsmcBilpb3QBovnvInQuJYpAx3oXi3DjCXhEg7RMfE4Xr4Tych7K1FCmm4vC2C/HZvvsatK0iIzupfuEbtZR8ATTvevYfyAvzeo9BZfaeog3a+HzWLJdk4ebtWYWLcmG6YPFLXceibXXECZqpfMYM7YZoiVaJIuLSpmb7Vs/ii1mnu8uqDtutm+/Ns93jfBaQTjgSgUSRmhikSTQd6Ed8chzxpSKGikhsA88/wqmiJtWFuIfdqY0lIbJFwo4wPjLkWloc8UoDje1IBXRAIesfhTfw0f33nsGo8LmDmJYtZSC/QzSOvqGPp4WP529tIc2PAfKsOPoi3BDV9kPB8lXDreTneVvj+3z5tCc/tH8uzk+7ne8x2RHXcVtypKTfCev/kIHGtFhzosuwhddaWwR5vzpIg2e2+f9EvRh/GXIKe48uvRRn74InXPsEeiYd1+EG3fxEQ3S/Py8LtjZh+N5ty+Mem8AiImdCwWS4lJfNfTNCdjrO9lFS9PjQeISJa6tQ/hSWdJCXFmHC4gQecEsWQcvcB6DOUzwDIcsOvf/3h4+Hx+b7fOGtyhy/722xAucsyKqZnpSFUWMJ1Z06gxn0QsDKfDxn0YuxW/D0k0cvJVf/EtB9nKxabjc2GfGXCUPk+QmZWGc4gv64CJ27KeDCzDFvEt+6LmsK46ekvmI2DN5z2Jkvvs+Ax9/KX+BDlzmJWLH8q4FmPGsS0RPy7nienhNouP94/50anfHU+u92zw1idD9ywNCTOBcQMAqzrvDBKyYO8ST4k742LXO/t6cFj3o2p91JR2+uzsuV6GfdAUNnjYvv/+r/u51mQrerCvo8NgsXIF+wkXInv28bra7hgF2169hL5OgOTvpVVliH0R2zC76wZfbAwWbt4NkTJ7/AmSM90mIEb4zkLM8T8Lk+c3AxXgtIHmHkDcUOJgjCB7AMfzDKtu4txJuvrh3eTf7XXaTqbVe19kq+7hptw/dJ1fG/P1+//zc55AP+/vP7q8fhmH/abuErhvcj/42z1a3+coU66IuP3xY3Y6T3Q13YZQxXXETIVvdwkrptTYaTQQyEdBEla1u1UrbdQmAJioyUaGJOlvd6pWu1koZNFGTiRpNNNnq1qwMrG1Vo4mGTDRoos1Wt5abaMlEiyYW2eq24CYWZGKBJpbZ6rZcKbMulUUTSzKxRBOrbHVbcftYkYkVmlhL+1iTiTUmQMeHmttIoNyBgDyOPflKFWutKjyZ4Q8mEChpkYBSCDCHoGMGwErrdZljFgGlEWAeQccOUKzWlEqAuQQdQ0BzWwSUToD5BIVobZRRgCkFHVGA5T9QVgGmFVTyRlFmAaYW1OJGUXIBZpfKxbVWlF4K00s5etmVKtdKB5MpvVTgnzrGQMFtlGJcFOaX0tJGKUovhemlHL1KbqMUpZfC9FJW3ChF6aUwvVQhbZSi9FKYXqqUN4rSS2F6qUreKEovhemlnOtinZ6i/FKYXzqXNkpTemlML+3oVXNORFN6aUwvrcSN0pReOgiBsvvSTBTE/NJG2mVN6aUxvbQVd1lTemlML12Iu6wpvzTml+4Yo9gURVN+acwv3TFGwUrVa21xkNKUXxrzS3eMUWyqoim/NOaX6SijNJt1UIIZTDDTUUbxKQslmMEEMy7BstyCGUowgwlmOsoo1vkZSjAT5FkdZ1TJTmZSLcww03FGsdZsKMMMZpgR46OhBDOYYKYU2WkowQwmmKmkJMhQfhnML1OLnsBQfhnML5tLxmwpvSymlwXRi1hKL4vpZZXoCSyll8X0so5eNbfJltLLYnrZjjCa9QSW0ssGqXxHGA3sZCabx/SyIr0spZfF9LKldN6xlF0Ws8tW0pHHUnZZzC5bS6ceS8llMbmKXDr4FJRcBSZXAeLZh3KrwNwqxMy+oNQqMLUKdzxU3AYXlFoFplZhpA0uKLMKzKzCikpTYhXBOVGOjAVzVMTMKkrJ9xSUWQVmViHn9QWlVoGpVdSi/ygotwrMrVJO7EtKrhKTqwTxLFNSdpWYXaUSk4GS0qvE9Cq1mAyUlF4lplfpPBebDJSUXyXmV+k8l+GIXVKClZhgpei5SsqvMqhFdJTRrBsomXIEJljpXBebSJSUYCUmWFmLJ6GSEqzEBKtycZsrSrAKE6wCcZsrSrAKE6xS4jZXlGAVJljl/BebPFWUYBUmWCX6r4ryq8L8qqy4zRXlV4X5VXWU0XzhiRKswgSrHMHYbKCiBKuCglclPjJT8sL8qmrxAFdRflWYX3Uuus6a8qvG/KpBChY1pVeN6VXLmVdN6VVjetVajDQ1pVeN6VW7CiqbedWUXzXmV90xxrCZV035VWN+1R1jDBvVa8qvGvOrLsXaJqVXjelVVyJFasqvOqipypl9zZRVw7qqmNr3t/Bs79owHeQqZc4UV/OguporkSn9vXB+UGHNO+4YvtCZMzXWPCiy5o5sbLzr74XzgzprbsVaac4UWvOg0poX4sb398L5QbU1L+WKac7UW/Og4JpX8u4zFdc8KLnmdWT3maprHpDPFeqF3efq+qSw37HJsNUHYEv7AftATtKAK++H9X1XsmfjN3AF/rDC74r2hk1bgKvxh0V+V7c3bBQHrswf1vld7d6w8RS4Un9Y6wfR5QFX7A+r/SB7PeDq/WHBH2THB1zNPyj6g6vjGzYjAKbsD0HdH5QYXoEp/ENQ+QclR1hgav8QFP9ByUEWmPo/BA0AcDV9y8ZZYFoAEPQAwJX1BeNhugAQtAHAlfYtG6qB6QRA0AoAV93ns2dgmgEQdAPAFfj5oikw/QAIGgLgavx83RSYlgAEPQFwdX7LZhvAtAUg6AuAK/VbPvQxnQEIWgOgI86PaQ5A0B0ALTs/pj0AQX8AXM2fLTcB0yGAoEUArupvDT+fYV/QJQBX+Ld86GD6BBA0CkDLvo/pFEDQKgAtlnKB6RVA0CwAHXF9TLsAgn4BGDnrYxoGEHQMwMg1XWB6BhA0DcBEXB/TNoCgbwAm4vqYzgEErQNw3QDLB16meQBB9wBMxPUx/QMIGgjgmgICeZkeAgRNBHB9AcuWLIBpI0DQRwDXG7AVP5+hX9BLANcesDU/n6Ff0E4A1yIocnY+01GAoKUArktQ8KGDaSpA0FUAG3F9TF8BgsYCuF6BsH9MawGC3gK4doGwf0x3AYL2AriOgbB/TIMBgg4DuK6BsH9MkwGCLgO4zoG0fwz/gk4DuO5BwYc+ptkwXnNvpr22h1P70H83p3uxbHyr8kv2x/DamoLxdbgvma6ymy9fV1mp+j+rvP+zS+X7vyg7/EWPV8x4xborX6d33NzlUS13r9PzDoHrCdyMYKpKE/TkS7LeY3TJT5KE/jcqkxBPG93PsdX4vCZJ5PQrhUkq5J5qMMgb5I7rOS6nqfs/i+F+PSxKPVzvzqTDloxXdJ2mWf+J6vv+C9beFpTeFiQ+pCeq7X8S4z1tNclTy1U7/7rX09BbP12mSfR/IePp5m3EsK7DIhbDdgzbrodlN8N1O/xZmMFAhn9Xw7+rcbvG3clHq4DxSqLm7vc1k8a1p/Go04BVnCWn2ctD8/HF/Q9/k3RvYfMlMsime3uerMyfw9eSvY32ntbqZXKISsrTqfdR6cKO/UfEPMfgrZRNM5KH5uObe6nYk+Lxzyar1EkhTze9lP8lK1KXarN9exm+6jJJMtqn2AJRh/GrB56s0vd0qU94lkWe0hhft7R1x8HNE2BG15volbpfB3jxxVdFj9Y9+gdIpOun9kSCjvVIMVh2mjF+ak/33o+jPDfniVTDU6vBa+hBYzN4j2L4d61HzzUGdjjH4/GWSX5Ih+5pVHhsHXAhSRaK8cojvR48dzkoV513N83Pjl8c9EzKW7VyWJ0qjcP9Nxk83vpuW6XtZv+tztBlgE+7QakybekmgTRG+zaf+Ihnab0Mf+E8Hcul0qir9bhSpgWT7tuOZOE8V6TGqJ1m+KM4umyeaiot2x1l0UXz9KvS7GqURZfMD79pqW9ooJ5lDfZvz4nmaP46Tc3h0zqeNRR+VEjz4v3X/hr3KUBPkheG66WCju7zgzSSerZapfkOF0Tvuu8GtjsUJIwX4Os0S+gDMo183obUaVvax1AmfzbWX/8058GIAW+h9OBtq8EL1+MxKR8DIqSZ7vjL6gnGs4uRgWNEGsDUgKEHs7ZDoCqGccUQRusxJORjJMtHNceoCCbNOfdq3vW/wPaWxD9QjEeH8eQ4QBTjEcOkrXzwG2UvT/DNKPGk1v8+zovD/lF0XDewabQfv8fx2GyHT3Z4yil/JdIWNZRHjaDyiZtmBaFQhsjWXwSVuJBPm5e3p7p5RYL8MD+e3MEmKtp58eYObY/1H3g850HiUcEJfHA/MPUk+hn5mPNB4hGm+0+07vr/zsuLFJ43MWlBsJMTeErlkTkxrXRfIvBsz2fc4AnUwGg1POiYp9vBM5RjNWX0KPnZRYy7p851rbRnQ4TQXl5VjqWBRDnD//Hisd9boeEx0vKX4VfantX7bsqmuaHpl6+cBfn5o14qMEzVCn8nbVrcwNKI57B+yNMJBvlhlb1sXtrtZtdmN7cfvn79P9cuNJAtgQAA"; \ No newline at end of file +window.searchData = "eJytnW1v4zYSx7+L+tbNaihSD3nXJ+AOdy2KFrjDIlgslESbGEnswPamzQX73Q+iJIvDmZFGjl9ta5EzFPmbGepP2XlLdtu/9snl1VvysN7cJpdgylWyqZ+a5DL5uf7ye33XJKvk6+4xuUxuHuv9vtl/6D+/uD88PSar4ePkMkm+rQY7DszRzs12sz/svt4ctrtJW9/hhoHdVfJc75rNIRjU6ApSY4++/D+TTvoWJ1m/fqwPh2nzQ5OT7L80u7bPpINjG60Hk9pxTe+aw4/zN3HXHJbeR+zlt9mFuGsOC9cC+dg1m9tmBqhjG/VqUPx/eWkbC278xXMGwmhwSTR0YxSguq2/KLx1rU73clMfmrvt7lVzY2PTRf4WLH/gTceAwtePu3Wjmcmu9XXf+nSvrZ95b12rZesWQP7ren+/qT9un9Y859H1s6DO2VTRHg9WQPHp2Eznumv/2rV/l2cxCPhbnosD2asmFFifM9Gg9MihybqbolPp6645/NRN1JopjazXu+ZwE3ZZvKZBgPxW39zL4YGuniU4qEVVaOBhipujrpHGadt2MiRUHsWA4G5zLhwkj5pgYPzNhILKGxcIjKupMFD5mQ4CxqMuBGTfVQFuBPan++2X5vC/n+7r9dMfTX273twdB3F4fW72H5gWk+GAKHlQGvvu8+e2wYN4P1zHro+4o1/m+vqMrptlruWN8nLXh+bvw4/N3XqzbAhtt+u+2zmH8svmdvlAGt/pHcPIgzQVtD+O5MvXzc1hvd3sP4SXp6kOCkc4Br54kBZnKSC8VVURoUMWFm0X5YAZ32Pzd/oVy4l003MlZcqz+hFAvOv554CF/pe5fr9XrrwJLqdKnNrfdJkTPOtK3dQYcvSw/N+meXh8ZdLA8dpknGaGGvvzUO/G+H+pd+v6+rEJLPoG6tTy89BN1CaCy+dSJ2KTWn0iHOlJy8751q256F2jjxCfsUJy2N9+v95/v97cN7v1obld7nlKM6HTzeWyk8ag1FHICJisci7/orYiDIJm1fePRNBbyAjiTHcaBzic2aey/vNzBfDRljZy/aAW6uyjE6LtzszTlDdRdx/dUb36Hf5kHX50yOjwyzyqdfnRJ6vLv8+rpNMjp+9cS2XCGV0uzzTxatLwEmvlefUbYnBJtJ2YqZcJGxpfsxX5JLlB8KypxpG/hbX4dJ2KWc4T6rBybcUqyC7w4hp4kppFvS+sfxp96Veq2Hc6wHjhdDUpsjErIgXtp6WLF5Wjl9McsWc0/9zcNn9PaOD++pnPaEabC89ousEKqD1utw9fn3Vuj22XegwexcYzIelZLGoxOYsxv7/FwnoHxPDx6ewiC7PkHlsv45ZzIlM74YQ5NuGJRVfPemyykFY8zGWsMi5nSJW8BZwORzQSpej65MwFosbzevfQrH942Y4WR1VjvKjWH34/dvnz69NTs+O3Vmyrsyy2bFm16PzwF0qdE2OYkzsX+Rd3JlOTMCd7zo1As++cnIDJDegi79yeZML1lAy5yO/0DnhiBLqt8PxYcIX5fV8/PvkjG3pYgq5pc8JtvX589T33TFIIruqzgm8u5ILx2nkyQGRPF/fBAJdGe+xvNsbnfcmRTW5uNp5Zb6oopjc2HbvzntiIjd1Mxum8j5nojL0pY1LwiyPxj/rpuhZOwdE1/a4PiWmSpX5jNvnKJO41vQt8bnZNvN0UvQ6NT3IbZ52uOUhpp7+84DTk2EnSeHCDM+k8jFGl1hONd2Eu4j3PJSSt1wklhL3h+Xc5Rb86dYu/2RmFS+eT1zs4h9NvWeq8zWlqnF+trjYxApy9/rxvnta7+vCP+t/1/n674fOY0Eqf0a7jzDJlcXi3Rk4wUu/pDHfCGM49hPj1Is00nHkIcWVRDEEuMOohBDl/H/Vh8n7cRJ374/HwBYBtdZYqIFtWlQJ++AvrwcQY5orCIv9iZZiahLnysGgET83Tdon3vv1pnjXVaXLqJ0vUIu9cnZpwPVWsFvmdrlgTI9CVrfmx4Nr1sdl93d/Xj09rvmqR6+/agfPWNLtw2nOmSKCDX4X36e9mLXXfxHrCpO9GfutS4ThQOvc399vDodnsD03wHuqodKLr+pUM7mbK1vzd4D7TU7hv1dif60OzxLfvdNt1OtMQfrjeLx5BfS1H6KIBPKyfP/6r+uFl0Qge1s+vD1UtHzcsGsJ9vez+u/YnOQ5Iflk/bmrGr//8neSONuaJ7dqeTirxNU+o2iVPJu9xikiVwwkSqcdZAlUuefKotyniBEfBVvr1mGHRaeO4kcYN1Nvoj6gbv4lm2pxlCy3ZVW2guYEveLFE9D31bdgFPsUts3zTcxvmae+aTavoe2bLutgz/zrLjPvp9+UXjIHbNIu+p7bMC3xOb5hF77rtMjuOT6tk7U+TL9/8W4vr7Sa5TMxFdlElq+TLunm8bX/eYdjg3myfnrrgvt3efPX/+alv9p+mjbS2cdf6Q5qsrtKVzS+gtJ8+ra6Gzv6C/2CwMX7iO0KyuoKVMRdlhvoB6Qeon0lWV2aVuQuoStTRkI4GdcyS1VW2yoqLAgB1zEjHDHW0yerKrixcpEWOOlrS0aKOLlldOa6jIx0d6pgnq6uc65iTjjnqWCSrq2Jl7IUBgzoWpGOBOpbJ6qrklrEkHUvUsRKWsSL9Krz8LQ0Vt45AyYEIHc9OujLuogSHOzP4YH7ASHMElCDACEELBsAqyy6gwhABpQgwRtDCAYYdNSUJMErQAgIZt0JAaQKME+RSrFGeAAMFLSbA0g+UKcBQQSmvE+UKMFhQietE2QIMl0nFqTaULoPpMp4utzL5RWGizpQuE2WnFhjIuXUyTILCeJlMWCdD4TIYLuPhKrh1MhQug+EyTlwnQ+EyGC6TS+tkKF0G02UKeZ0oXQbTZUp5nShdBtNlfN5iM56heBmMV+bxYpNXRvHKMF5ZC4xJuZXKKF4Zxivz1Q/YzhSvLCqALTLGcPecMTUQA5a1yBg2AWUUsAwDlrXIGMt2poBlGLCsZcY4tjMlLMOEZYUQUhnlK8N8ZS0xJueSfUb5yjBfWSWGVEb5yjBfNhXLjKV8WcyXBSkeLcXLYrysEePRUrwsxstmYjxaipeN9lger4JbZMtsszBe1uPFBrOleFmMl/V4VWxnipfFeFkJL0vxshgvK6cvS/GyGC9bSbsnS+mymC6Ximg6SpfDdDmRLkfpcpguZ0SsHaXLYbpcJqLpKF0O0+VaXjL2McVRuly0i3fCGjtmG4/Zcrn0sOIoWg6j5QrpecVRthxmy5XSI4ujaDmMlqvEpxaKlsNo5an44ELJyjFZuUhWTsnKMVl5y0oG3PrmlKwck5VLu66ccpVjrnIrjplilWOscifGf07ByqMHxFyK/5x5RMRg5YUY/zklK8dk5aUYwzlFK8do5ZUYwzllK8dsFan4JFJQuAoMVwHijq2gdBWYrsLTZVjPlK4C01V42YHdNxWUrwLzVVgBzYLiVWC8ihaYjJ8uileB8SpaYjJ2y1VQvopIgyjER5GCkSEwX0UpLxTlq8B8FZW8UJSvAvNVtsRk7JNbSfkqMV+lpGaVlK4S01UacaFKSleJ6So9Xey2qaR0lZiu0ldFXvWhfJWYr9LzxW6bSspXifkqJUGipHSVmK6yEHflJaWrjFQuWZAoGaEL01WKgkRJ4SoxXJUsSFQUrgrDVcmCREXxqjBeVQuMZbc+FcWrwnhVLTCWrasVxavCeFVeN2UfNyuKV4XxqqRNV0XhqjBcVS4SUlG8KoxXJRfHiuJVYbyqUiKkonRVkY4q18aK0VJjMTUVEemu4e7BZ33/FhrLy4spI6mmkaaaiqp8dynuHsmqqeeM1Qe6a3H/SFlNPWpsvequxf0jcTVtCbJs7u+uxf0jfTUVBdaUUVjTSGJN5ZTWXYv7RyprOiGzpozOmkZCayorrSkjtaYReyDnNuC0fCLmy+kNWDk/Ys9r9JatgcBJ+rGm72V6y5ZB4FT9WNbvdH3+KIMT9mNl34v1vCAInLYfi/tesec1QeAE/ljh96K9ZSs5cBp/LPJ73d6xFQY4mT/W+UE6QgJO6I+UfvDivRA8jNYPkdgPZuIsiZH7IdL7wUv4ji2RwCj+EEn+4HV84TiKgS+S/cFMHCoxwj9Eyj8Y+SkUGO0fIvEfvKDv2CIPjP4P0QEAeE2fLxzMCQBERwDgVX1WJAHmDACiQwDwur4T+jPwRecA4KV9x9ct5iQAoqMA8Oq+4J85DIDoNAC8wO9YsQaY8wCIDgTAa/yOFWyAORKA6EwAvMzv2Ec9YE4FIDoWAK/0u5Lvz9AXnQyAF/sdn7qYswGIDgfAK/7S/DP4RScE4EV/af4Z/qJDAvC6vzT/DH/ROQF46V+Yf+akAKKjAvDyvzD/zGkBRMcF4E8Acj71MwcGEJ0YgD8EyPnkyZwZQHRoAFbSR4A5NIDo1AD8QQBft5ljA4jODcAfBQiVgzk5gOjoAKz4sgYwpwcQHR+AlZU4YA4QIDpBACs/cABziADRKQK4iUcO5hxh+My/ivTS7A7NbfcDF+2bRNfJ6i353L+iZNLhTam3JIPk8u3bKmk3PZdv376N7yb5jwfr/lrrrv122GhpfOfqLWm3bSoL3Vvzo5EsGE3XxxX9oEypMjm+rTdahTQcWm+v7P41rvs3q3p/afdv3vst+3bVMI60HAY0WLK5bmTdz53edL9oHCyBDW5aN/OhqaZ7NTSw5wJ7y4d2/IJSMH/B0ppKZzF8UzSwFCxEP6/9JOb9cvTLnvXTbft/Xb9MeX+9sP3y9GbKvn/lhmXKB5gHD9aqRu7fMx1HXAUj7tGwvcV8cGF1q3Zbf3n2f7xptB6AmS6xQRY9WCFdnNzWX/7qf1U3QKcYzeinq7NDOQymThkiR2P77rd2AmPBDeqnu/trCUF6Cebbqe+vtULuLgtQzo3S1Prx9bn/fY8gcQaWKl3e9JZ2w3f2A1MupFV7g0db5CZtHtrTTTvi2wT3lpkhInUwtF+rGC25oDSAGWL6WLK6fDFrc/y1zsBywESfbHQ5LnpHOMhygcmhSpi+bNg+gdn+//PeZzXcSZoO0zR8MpQocLoccfx10HFEwTr2SSvX2UIlHoKIzvphFv0oi6Esgg674Xe5gogK6mDR33Kpi6zuW6XBkoZ1xihtBH9yKLjlYFDQ16JCN3WjQRJXEMKsC6vRWmcjnLjAWqFLIKM1kmmzAN5CF6njH6YJbjEoJaYv1oUuSAdzdNoCjJWrOtiikxbYKnULOtiiUxbca6lbgDhATXBnfRIadhfpkDeNbvr6H4YJsnjIcKobX/cTdLX/fbrgRsNthi7OR0N7/6tatJAGSaXUxYKvof6vnvi/OBLcaVDfKx0gXT2mlS9YkEp3p10NZbbPNoz2FHTGqBkTEJv12bbsU1J1hOX4uKRjeviC0egmYPloq/+3r7qmd2b71O/6f/Ph32Fv3revhtKQDmV72OWD1SGNvocU5IMwzQ91ta9Lrh90Pji3un1x9B3ooKaEUZTpZrf7bmFgI3xGzoaybnVIDL/IcV8/9j/aESAWPqaAblJjeyQGHHpsVk5fZJQLhyI0q4vS4CuhwfhCQ5kdZlO5NMevtQYGw+1uNjCa6XaDwTdzA4vhhvy4Ac50cxn8bacgCwSJKdPl8uOfZgqshEKLLr357+MFsReMA/q5N33smeHhfShl/VTmQ0Lo21VDPhierMEcV1E36YiHLBhS0bsulHb6vxwQUBo8b/Z3oVu1/qvnAQNhbCoFmfFLw0wAuXDqzVKD8UYtD6Pc6sIRWyOJIw/zslVA+mmVPK+fm8f1pkkurz59+/Z/pqB74A=="; \ No newline at end of file diff --git a/api/learning/assets/style.css b/api/learning/assets/style.css index 178bfb0..7f80f3d 100644 --- a/api/learning/assets/style.css +++ b/api/learning/assets/style.css @@ -1,115 +1,256 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --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; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --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: #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; - /* reference not included as links will be colored with the kind that it points to */ - --light-color-document: #000000; - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --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; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --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: #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; - /* reference not included as links will be colored with the kind that it points to */ - --dark-color-document: #ffffff; - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { +@layer typedoc { :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --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; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --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: #9f5f30; + --light-color-ts-method: #be3989; + --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: #c73c3c; + --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; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --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; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --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: #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: #ff6060; + --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; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --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-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); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --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( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --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-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); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --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( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + html { + color-scheme: var(--color-scheme); + } + + body { + margin: 0; + } + + :root[data-theme="light"] { --color-background: var(--light-color-background); --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); @@ -145,23 +286,26 @@ --color-ts-type-alias: var(--light-color-ts-type-alias); --color-document: var(--light-color-document); + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } -} -@media (prefers-color-scheme: dark) { - :root { + :root[data-theme="dark"] { --color-background: var(--dark-color-background); --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); @@ -197,1297 +341,1270 @@ --color-ts-type-alias: var(--dark-color-ts-type-alias); --color-document: var(--dark-color-document); + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } -} -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --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-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); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --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( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --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-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); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --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( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } -*:focus-visible, -.tsd-accordion-summary:focus-visible svg { - outline: 2px solid var(--color-focus-outline); -} + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} + dl, + menu, + ol, + ul { + margin: 1em 0; + } -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} + dd { + margin: 0 0 0 34px; + } -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} + .container { + max-width: 1700px; + padding: 0 2rem; + } -dl, -menu, -ol, -ul { - margin: 1em 0; -} + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; + } + footer > p { + margin: 0 1em; + } -dd { - margin: 0 0 0 40px; -} + .container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); + } -.container { - max-width: 1700px; - padding: 0 2rem; -} + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } + } + @keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + } -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -footer > p { - margin: 0 1em; -} + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } -@keyframes fade-in { - from { + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } - to { + pre:hover > button, + pre > button.visible { opacity: 1; } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } - to { - opacity: 0; + + .tsd-typography { + line-height: 1.333em; } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; } - 33% { - opacity: 0; + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; } - 100% { - opacity: 1; + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; } - 66% { - opacity: 0; + .tsd-typography table { + border-collapse: collapse; + border: none; } - 100% { - opacity: 0; + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } - to { - transform: translate(0, 0); + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; } - to { - transform: translate(100%, 0); + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; } -} -body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); -} -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} -a.tsd-anchor-link { - color: var(--color-text); -} + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} + .tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } -pre { - position: relative; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: -moz-fit-content; - width: fit-content; - align-items: center; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus-visible + svg { - outline: 2px solid var(--color-focus-outline); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } -.settings-label { - font-weight: bold; - text-transform: uppercase; - display: inline-block; -} + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } -.tsd-filter-visibility .settings-label { - margin: 0.75rem 0 0.5rem 0; -} + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } -.tsd-theme-toggle .settings-label { - margin: 0.75rem 0.75rem 0 0; -} + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} + .tsd-anchor { + position: relative; + top: -100px; + } -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); + .tsd-member { + position: relative; } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} + .tsd-navigation.settings { + margin: 1rem 0; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } -.tsd-anchor { - position: relative; - top: -100px; -} + .tsd-page-navigation-section { + margin-left: 10px; + } + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 20px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-navigation .tsd-nav-link { - display: none; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation-section { - margin-left: 10px; -} -.tsd-page-navigation-section > summary { - padding: 0.25rem; -} -.tsd-page-navigation-section > div { - margin-left: 20px; -} -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; - vertical-align: text-top; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - 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; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} -.tsd-panel-group > .tsd-accordion-summary { - margin-bottom: 1rem; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-index-signature:not(:last-child) { - margin-bottom: 1em; -} -.tsd-signatures .tsd-index-signature .tsd-signature { - border-width: 1px; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + .tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; + } + /* + We need to be careful to target the arrow indicating whether the accordion + is open, but not any other SVGs included in the details element. +*/ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + } -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} + .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; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } -img { - max-width: 100%; -} + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} + #tsd-search { + transition: background-color 0.2s; + } + #tsd-search .title { + position: relative; + z-index: 2; + } + #tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; + } + #tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); + } + #tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; + } + #tsd-search .field input, + #tsd-search .title, + #tsd-toolbar-links a { + transition: opacity 0.2s; + } + #tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + #tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; + } + #tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search .results li.state { + display: none; + } + #tsd-search .results li.current:not(.no-results), + #tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); + } + #tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; + } + #tsd-search .results a:before { + top: 10px; + } + #tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; + } + #tsd-search.has-focus { + background-color: var(--color-accent); + } + #tsd-search.has-focus .field input { + top: 0; + opacity: 1; + } + #tsd-search.has-focus .title, + #tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; + } + #tsd-search.has-focus .results { + visibility: visible; + } + #tsd-search.loading .results li.state.loading { + display: block; + } + #tsd-search.failure .results li.state.failure { + display: block; + } -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} + #tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; + } + #tsd-toolbar-links a { + margin-left: 1.5rem; + } + #tsd-toolbar-links a:hover { + text-decoration: underline; + } -.deprecated { - text-decoration: line-through !important; -} + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.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); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } -*::-webkit-scrollbar { - width: 0.75rem; -} + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; + } + .tsd-page-toolbar a.title { + font-weight: bold; + } + .tsd-page-toolbar a.title:hover { + text-decoration: underline; + } + .tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; + } + .tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; + } + .tsd-page-toolbar .table-cell:first-child { + width: 100%; + } + .tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; + } -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} + .tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); + } + .tsd-widget.no-caption { + width: 40px; + } + .tsd-widget.no-caption:before { + margin: 0; + } -/* mobile */ -@media (max-width: 769px) { .tsd-widget.options, .tsd-widget.menu { - display: inline-block; + display: none; } - - .container-main { - display: flex; + input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; + } + input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; } - html .col-content { - float: none; + + img { max-width: 100%; - width: 100%; } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; } - html .col-sidebar > *:last-child { - padding-bottom: 20px; + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; visibility: hidden; } - .to-has-menu .overlay { - animation: fade-in 0.4s; + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; } - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; + .deprecated { + text-decoration: line-through !important; } - .from-has-menu .overlay { - animation: fade-out 0.4s; + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; + .tsd-kind-project { + color: var(--color-ts-project); } - - .has-menu body { - overflow: hidden; + .tsd-kind-module { + color: var(--color-ts-module); } - .has-menu .overlay { - visibility: visible; + .tsd-kind-namespace { + color: var(--color-ts-namespace); } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; + .tsd-kind-enum { + color: var(--color-ts-enum); } - .has-menu .tsd-navigation { - max-height: 100%; + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); } - #tsd-toolbar-links { - display: none; + .tsd-kind-variable { + color: var(--color-ts-variable); } - .tsd-navigation .tsd-nav-link { - display: flex; + .tsd-kind-function { + color: var(--color-ts-function); } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; + .tsd-kind-class { + color: var(--color-ts-class); } - - .col-sidebar { - grid-area: sidebar; + .tsd-kind-interface { + color: var(--color-ts-interface); } - .col-content { - grid-area: content; - padding: 0 1rem; + .tsd-kind-constructor { + color: var(--color-ts-constructor); } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; + .tsd-kind-property { + color: var(--color-ts-property); } - .site-menu { - margin-top: 1rem; + .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); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); } -} -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); } - .col-sidebar { - display: contents; + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } - .page-menu { - grid-area: toc; - padding-left: 1rem; + *::-webkit-scrollbar { + width: 0.75rem; } - .site-menu { - grid-area: sidebar; + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); } - .site-menu { - margin-top: 1rem; + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; + /* mobile */ + @media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } } diff --git a/api/learning/classes/ChofetzChaimEvent.html b/api/learning/classes/ChofetzChaimEvent.html index 60a7aa4..22cc029 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 +ChofetzChaimEvent | @hebcal/learning

Class ChofetzChaimEvent

Event wrapper around a Chofetz Chaim instance

+

Hierarchy

  • Event
    • ChofetzChaimEvent

Constructors

constructor

Properties

alarm? category date @@ -9,56 +9,56 @@ memo? reading

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 2ef3b27..cf0b67a 100644 --- a/api/learning/classes/DafPage.html +++ b/api/learning/classes/DafPage.html @@ -1,12 +1,12 @@ -DafPage | @hebcal/learning

Class DafPage

Represents a tractate and page number

-

Hierarchy (view full)

Constructors

constructor +DafPage | @hebcal/learning

Class DafPage

Represents a tractate and page number

+

Hierarchy (View Summary)

Constructors

constructor

Properties

blatt name verses? -

Methods

getBlatt -getName +

Methods

getBlatt +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"

    +

Constructors

constructor

  • new DafPage(name: string, blatt: string | number): DafPage

  • Initializes a daf yomi instance

    +

    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): 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
+

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 0faaa3f..ef2257b 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 +DafPageEvent | @hebcal/learning

Class DafPageEvent

Event wrapper around a DafPage instance

+

Hierarchy (View Summary)

Constructors

constructor

Properties

alarm? category? daf @@ -9,55 +9,55 @@ mask memo?

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 f13153f..2c28cb8 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 +DafWeeklyEvent | @hebcal/learning

Class DafWeeklyEvent

Event wrapper around a daily weekly

+

Hierarchy (View Summary)

Constructors

constructor

Properties

alarm? category? daf @@ -9,55 +9,55 @@ mask memo?

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 e1d5a70..3c05eec 100644 --- a/api/learning/classes/DafYomi.html +++ b/api/learning/classes/DafYomi.html @@ -1,13 +1,13 @@ -DafYomi | @hebcal/learning

Class DafYomi

Returns the Daf Yomi for given date

-

Hierarchy (view full)

Constructors

constructor +DafYomi | @hebcal/learning

Class DafYomi

Returns the Daf Yomi for given date

+

Hierarchy (View Summary)

Constructors

constructor

Properties

blatt name verses? -

Methods

getBlatt -getName +

Methods

getBlatt +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"

    +

Constructors

constructor

Properties

blatt

blatt: string | number

name

name: string

Optionalverses

verses?: string

Methods

getBlatt

getName

render

  • render(locale?: string): 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
+

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 b79436b..cb764be 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 +DafYomiEvent | @hebcal/learning

Class DafYomiEvent

Event wrapper around a DafYomi instance

+

Hierarchy (View Summary)

Constructors

constructor

Properties

alarm? category? daf @@ -9,55 +9,55 @@ mask memo?

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 76c9908..f71d084 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 +DailyRambamEvent | @hebcal/learning

Class DailyRambamEvent

Event wrapper around a Daily Rambam instance

+

Hierarchy

  • Event
    • DailyRambamEvent

Constructors

constructor

Properties

alarm? category date @@ -9,57 +9,57 @@ memo? reading

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 2a8a088..666049e 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 +MishnaYomiEvent | @hebcal/learning

Class MishnaYomiEvent

Event wrapper around a Mishna Yomi instance

+

Hierarchy

  • Event
    • MishnaYomiEvent

Constructors

constructor

Properties

alarm? category date @@ -7,59 +7,59 @@ emoji? mask memo? -mishnaYomi +mishnaYomi

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 7c9f0f4..4ac0f2f 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 +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
+

Constructors

constructor

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 a30d44e..bf76151 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 +NachYomiEvent | @hebcal/learning

Class NachYomiEvent

Event wrapper around a Nach Yomi instance

+

Hierarchy

  • Event
    • NachYomiEvent

Constructors

constructor

Properties

alarm? category date @@ -7,59 +7,59 @@ emoji? mask memo? -nachYomi +nachYomi

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 5d1fb36..64cc3ba 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) +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
+

Constructors

constructor

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 b906e10..54cbb39 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 +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 @@ -10,57 +10,57 @@ memo? reading

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 20e67e0..953c7c6 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 +PsalmsEvent | @hebcal/learning

Class PsalmsEvent

Event wrapper around a daily Psalms / Tehillim

+

Hierarchy

  • Event
    • PsalmsEvent

Constructors

constructor

Properties

alarm? category date @@ -9,58 +9,58 @@ memo? reading

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 f927520..f5c5a0f 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 +ShemiratHaLashonEvent | @hebcal/learning

Class ShemiratHaLashonEvent

Event wrapper around a Sefer Shemirat HaLashon instance

+

Hierarchy

  • Event
    • ShemiratHaLashonEvent

Constructors

constructor

Properties

alarm? category date @@ -9,58 +9,58 @@ memo reading

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 6d42626..797dc30 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 +YerushalmiYomiEvent | @hebcal/learning

Class YerushalmiYomiEvent

Event wrapper around a Yerushalmi Yomi result

+

Hierarchy

  • Event
    • YerushalmiYomiEvent

Constructors

constructor

Properties

alarm? category daf @@ -9,55 +9,55 @@ mask memo?

Methods

basename -clone -getCategories -getDate -getDesc -getEmoji -getFlags -observedIn -observedInDiaspora -observedInIsrael +clone +getCategories +getDate +getDesc +getEmoji +getFlags +observedIn +observedInDiaspora +observedInIsrael render -renderBrief +renderBrief url -

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 +

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, +

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 title of this event. Note that these description +

    Returns string

clone

  • clone(): Event

  • Makes a clone of this Event object

    +

    Returns Event

    Deprecated

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
+

    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): 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): 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): 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
+

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 edc4988..49f5aa3 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
+chofetzChaim | @hebcal/learning

Function chofetzChaim

Settings

Member Visibility
diff --git a/api/learning/functions/dafWeekly.html b/api/learning/functions/dafWeekly.html index 3d8aed6..6eab611 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
+dafWeekly | @hebcal/learning

Function dafWeekly

Settings

Member Visibility
diff --git a/api/learning/functions/dailyPsalms.html b/api/learning/functions/dailyPsalms.html index fdf7ce7..03c5d39 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
+dailyPsalms | @hebcal/learning

Function dailyPsalms

Settings

Member Visibility
diff --git a/api/learning/functions/dailyRambam1.html b/api/learning/functions/dailyRambam1.html index 2c1859a..d8c3035 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
+dailyRambam1 | @hebcal/learning

Function dailyRambam1

Settings

Member Visibility
diff --git a/api/learning/functions/pirkeiAvot.html b/api/learning/functions/pirkeiAvot.html index 8eaa3c2..8edc91e 100644 --- a/api/learning/functions/pirkeiAvot.html +++ b/api/learning/functions/pirkeiAvot.html @@ -1,12 +1,12 @@ -pirkeiAvot | @hebcal/learning

Function pirkeiAvot

  • pirkeiAvot(dt, il): number[] | null

  • Pirkei Avot being studied on Shabbat between Pesach and Rosh Hashana

    +pirkeiAvot | @hebcal/learning

    Function pirkeiAvot

    • pirkeiAvot(dt: Date | HDate, il: boolean): number[] | null

    • Pirkei Avot being studied on Shabbat between Pesach and Rosh Hashana

      "From at least the time of Saadia Gaon (10th century), it has been customary to study one chapter a week on each Shabbat between Passover and Shavuot; today, the tractate is generally studied 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
    +

    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 b09d024..530c6c0 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
+shemiratHaLashon | @hebcal/learning

Function shemiratHaLashon

Settings

Member Visibility
diff --git a/api/learning/functions/yerushalmiYomi.html b/api/learning/functions/yerushalmiYomi.html index d96b331..5d8428c 100644 --- a/api/learning/functions/yerushalmiYomi.html +++ b/api/learning/functions/yerushalmiYomi.html @@ -1,4 +1,4 @@ -yerushalmiYomi | @hebcal/learning

Function yerushalmiYomi

  • yerushalmiYomi(date, config): YerushalmiReading | null

  • Using the Vilna edition, the Yerushalmi Daf Yomi program takes +yerushalmiYomi | @hebcal/learning

    Function yerushalmiYomi

    • yerushalmiYomi(
          date: number | Date | HDate,
          config: any,
      ): YerushalmiReading | null

    • Using the Vilna edition, the Yerushalmi Daf Yomi program takes ~4.25 years or 51 months. Unlike the Daf Yomi Bavli cycle, this Yerushalmi cycle skips both Yom Kippur and Tisha B'Av (returning null). @@ -9,6 +9,6 @@

      Throws an exception if the date is before Daf Yomi Yerushalmi cycle began (2 February 1980 for Vilna, 14 November 2022 for Schottenstein).

      -

      Parameters

      • date: number | Date | HDate

        Hebrew or Gregorian date

        +

        Parameters

        • date: number | Date | HDate

          Hebrew or Gregorian date

        • config: any

          either vilna or schottenstein

          -

        Returns YerushalmiReading | null

    Settings

    Member Visibility
    +

Returns YerushalmiReading | null

Settings

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

@hebcal/learning

Class Hierarchy

Settings

Member Visibility
+@hebcal/learning

@hebcal/learning

Hierarchy Summary

Settings

Member Visibility
diff --git a/api/learning/index.html b/api/learning/index.html index add8c29..cca7263 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
    • @@ -28,10 +28,10 @@
  • Pirkei Avot studied on Shabbat between Pesach and Rosh Hashana - pirkeiAvotSummer
-

Installation

$ npm install @hebcal/learning
+
Installation
$ npm install @hebcal/learning
 

 
-
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'));
+
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
+

API Documentation

Settings

Member Visibility

On This Page

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

@hebcal/learning

Index

Classes

ChofetzChaimEvent -DafPage -DafPageEvent -DafWeeklyEvent -DafYomi -DafYomiEvent -DailyRambamEvent -MishnaYomiEvent -MishnaYomiIndex -NachYomiEvent -NachYomiIndex -PirkeiAvotSummerEvent -PsalmsEvent -ShemiratHaLashonEvent -YerushalmiYomiEvent -

Type Aliases

ChofetzChaimReading -MishnaYomi -NachYomi -PsalmBeginEnd -RambamReading -ShemiratHaLashonReading -YerushalmiReading -

Variables

dafWeeklyStart -mishnaYomiStart -nachYomiStart -schottenstein -vilna -

Functions

chofetzChaim -dafWeekly -dailyPsalms -dailyRambam1 -pirkeiAvot -shemiratHaLashon -yerushalmiYomi -

Settings

Member Visibility
+@hebcal/learning

@hebcal/learning

Classes

ChofetzChaimEvent
DafPage
DafPageEvent
DafWeeklyEvent
DafYomi
DafYomiEvent
DailyRambamEvent
MishnaYomiEvent
MishnaYomiIndex
NachYomiEvent
NachYomiIndex
PirkeiAvotSummerEvent
PsalmsEvent
ShemiratHaLashonEvent
YerushalmiYomiEvent

Type Aliases

ChofetzChaimReading
MishnaYomi
NachYomi
PsalmBeginEnd
RambamReading
ShemiratHaLashonReading
YerushalmiReading

Variables

dafWeeklyStart
mishnaYomiStart
nachYomiStart
schottenstein
vilna

Functions

chofetzChaim
dafWeekly
dailyPsalms
dailyRambam1
pirkeiAvot
shemiratHaLashon
yerushalmiYomi

Settings

Member Visibility

On This Page

Classes
Type Aliases
Variables
Functions
diff --git a/api/learning/types/ChofetzChaimReading.html b/api/learning/types/ChofetzChaimReading.html index de3b5e2..1ca7889 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
+ChofetzChaimReading | @hebcal/learning

Type Alias ChofetzChaimReading

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

Type declaration

  • b: string | number
  • e: string | number | number[]
  • k: string
  • OptionaltextBegin?: string
  • OptionaltextEnd?: string

Settings

Member Visibility
diff --git a/api/learning/types/MishnaYomi.html b/api/learning/types/MishnaYomi.html index c577022..7c5604e 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
+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
diff --git a/api/learning/types/NachYomi.html b/api/learning/types/NachYomi.html index 11daf9e..2fe9902 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
+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
diff --git a/api/learning/types/PsalmBeginEnd.html b/api/learning/types/PsalmBeginEnd.html index 2c69371..1b01536 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
+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 e84320d..c5f984e 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
+RambamReading | @hebcal/learning

Type Alias RambamReading

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

Type declaration

  • name: string
  • perek: number | string

Settings

Member Visibility
diff --git a/api/learning/types/ShemiratHaLashonReading.html b/api/learning/types/ShemiratHaLashonReading.html index ed0ebae..431cda6 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
+ShemiratHaLashonReading | @hebcal/learning

Type Alias ShemiratHaLashonReading

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

Type declaration

  • 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 26cba7c..a913c65 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
+YerushalmiReading | @hebcal/learning

Type Alias YerushalmiReading

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

Type declaration

  • blatt: number
  • ed: string
  • name: string

Settings

Member Visibility
diff --git a/api/learning/variables/dafWeeklyStart.html b/api/learning/variables/dafWeeklyStart.html index 484fa4b..8dd8a76 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
+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 02e06e0..245a79e 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
+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 6b5e997..fb9198f 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
+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 76f6ae4..295e447 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: "schottenstein";
    shas: readonly [readonly ["Berakhot", 94], readonly ["Peah", 73], readonly ["Demai", 77], readonly ["Kilayim", 84], readonly ["Sheviit", 87], readonly ["Terumot", 107], readonly ["Maasrot", 46], readonly ["Maaser Sheni", 59], readonly ["Challah", 49], readonly ["Orlah", 42], readonly ["Bikkurim", 26], readonly ["Shabbat", 113], readonly ["Eruvin", 71], readonly ["Pesachim", 86], readonly ["Shekalim", 61], readonly ["Yoma", 57], readonly ["Sukkah", 33], readonly ["Beitzah", 49], readonly ["Rosh Hashanah", 27], readonly ["Taanit", 31], readonly ["Megillah", 41], readonly ["Chagigah", 28], readonly ["Moed Katan", 23], readonly ["Yevamot", 88], readonly ["Ketubot", 77], readonly ["Nedarim", 42], readonly ["Nazir", 53], readonly ["Sotah", 52], readonly ["Gittin", 53], readonly ["Kiddushin", 53], readonly ["Bava Kamma", 40], readonly ["Bava Metzia", 35], readonly ["Bava Batra", 39], readonly ["Sanhedrin", 75], readonly ["Shevuot", 49], readonly ["Avodah Zarah", 34], readonly ["Makkot", 11], readonly ["Horayot", 18], readonly ["Niddah", 11]];
    skipYK9Av: false;
    startAbs: number;
    startDate: Date;
} = ...

Yerushalmi Yomi configuration for Schottenstein Edition

-

Settings

Member Visibility
+schottenstein | @hebcal/learning

Variable schottensteinConst Readonly

schottenstein: {
    ed: "schottenstein";
    shas: readonly [
        readonly ["Berakhot", 94],
        readonly ["Peah", 73],
        readonly ["Demai", 77],
        readonly ["Kilayim", 84],
        readonly ["Sheviit", 87],
        readonly ["Terumot", 107],
        readonly ["Maasrot", 46],
        readonly ["Maaser Sheni", 59],
        readonly ["Challah", 49],
        readonly ["Orlah", 42],
        readonly ["Bikkurim", 26],
        readonly ["Shabbat", 113],
        readonly ["Eruvin", 71],
        readonly ["Pesachim", 86],
        readonly ["Shekalim", 61],
        readonly ["Yoma", 57],
        readonly ["Sukkah", 33],
        readonly ["Beitzah", 49],
        readonly ["Rosh Hashanah", 27],
        readonly ["Taanit", 31],
        readonly ["Megillah", 41],
        readonly ["Chagigah", 28],
        readonly ["Moed Katan", 23],
        readonly ["Yevamot", 88],
        readonly ["Ketubot", 77],
        readonly ["Nedarim", 42],
        readonly ["Nazir", 53],
        readonly ["Sotah", 52],
        readonly ["Gittin", 53],
        readonly ["Kiddushin", 53],
        readonly ["Bava Kamma", 40],
        readonly ["Bava Metzia", 35],
        readonly ["Bava Batra", 39],
        readonly ["Sanhedrin", 75],
        readonly ["Shevuot", 49],
        readonly ["Avodah Zarah", 34],
        readonly ["Makkot", 11],
        readonly ["Horayot", 18],
        readonly ["Niddah", 11],
    ];
    skipYK9Av: false;
    startAbs: number;
    startDate: Date;
} = ...

Yerushalmi Yomi configuration for Schottenstein Edition

+

Type declaration

  • Readonlyed: "schottenstein"
  • Readonlyshas: readonly [
        readonly ["Berakhot", 94],
        readonly ["Peah", 73],
        readonly ["Demai", 77],
        readonly ["Kilayim", 84],
        readonly ["Sheviit", 87],
        readonly ["Terumot", 107],
        readonly ["Maasrot", 46],
        readonly ["Maaser Sheni", 59],
        readonly ["Challah", 49],
        readonly ["Orlah", 42],
        readonly ["Bikkurim", 26],
        readonly ["Shabbat", 113],
        readonly ["Eruvin", 71],
        readonly ["Pesachim", 86],
        readonly ["Shekalim", 61],
        readonly ["Yoma", 57],
        readonly ["Sukkah", 33],
        readonly ["Beitzah", 49],
        readonly ["Rosh Hashanah", 27],
        readonly ["Taanit", 31],
        readonly ["Megillah", 41],
        readonly ["Chagigah", 28],
        readonly ["Moed Katan", 23],
        readonly ["Yevamot", 88],
        readonly ["Ketubot", 77],
        readonly ["Nedarim", 42],
        readonly ["Nazir", 53],
        readonly ["Sotah", 52],
        readonly ["Gittin", 53],
        readonly ["Kiddushin", 53],
        readonly ["Bava Kamma", 40],
        readonly ["Bava Metzia", 35],
        readonly ["Bava Batra", 39],
        readonly ["Sanhedrin", 75],
        readonly ["Shevuot", 49],
        readonly ["Avodah Zarah", 34],
        readonly ["Makkot", 11],
        readonly ["Horayot", 18],
        readonly ["Niddah", 11],
    ]
  • ReadonlyskipYK9Av: false
  • ReadonlystartAbs: number
  • ReadonlystartDate: Date

Settings

Member Visibility
diff --git a/api/learning/variables/vilna.html b/api/learning/variables/vilna.html index c92e908..df4c301 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: "vilna";
    shas: readonly [readonly ["Berakhot", 68], readonly ["Peah", 37], readonly ["Demai", 34], readonly ["Kilayim", 44], readonly ["Sheviit", 31], readonly ["Terumot", 59], readonly ["Maasrot", 26], readonly ["Maaser Sheni", 33], readonly ["Challah", 28], readonly ["Orlah", 20], readonly ["Bikkurim", 13], readonly ["Shabbat", 92], readonly ["Eruvin", 65], readonly ["Pesachim", 71], readonly ["Beitzah", 22], readonly ["Rosh Hashanah", 22], readonly ["Yoma", 42], readonly ["Sukkah", 26], readonly ["Taanit", 26], readonly ["Shekalim", 33], readonly ["Megillah", 34], readonly ["Chagigah", 22], readonly ["Moed Katan", 19], readonly ["Yevamot", 85], readonly ["Ketubot", 72], readonly ["Sotah", 47], readonly ["Nedarim", 40], readonly ["Nazir", 47], readonly ["Gittin", 54], readonly ["Kiddushin", 48], readonly ["Bava Kamma", 44], readonly ["Bava Metzia", 37], readonly ["Bava Batra", 34], readonly ["Shevuot", 44], readonly ["Makkot", 9], readonly ["Sanhedrin", 57], readonly ["Avodah Zarah", 37], readonly ["Horayot", 19], readonly ["Niddah", 13]];
    skipYK9Av: true;
    startAbs: number;
    startDate: Date;
} = ...

Yerushalmi Yomi configuration for Vilna Edition

-

Settings

Member Visibility
+vilna | @hebcal/learning

Variable vilnaConst Readonly

vilna: {
    ed: "vilna";
    shas: readonly [
        readonly ["Berakhot", 68],
        readonly ["Peah", 37],
        readonly ["Demai", 34],
        readonly ["Kilayim", 44],
        readonly ["Sheviit", 31],
        readonly ["Terumot", 59],
        readonly ["Maasrot", 26],
        readonly ["Maaser Sheni", 33],
        readonly ["Challah", 28],
        readonly ["Orlah", 20],
        readonly ["Bikkurim", 13],
        readonly ["Shabbat", 92],
        readonly ["Eruvin", 65],
        readonly ["Pesachim", 71],
        readonly ["Beitzah", 22],
        readonly ["Rosh Hashanah", 22],
        readonly ["Yoma", 42],
        readonly ["Sukkah", 26],
        readonly ["Taanit", 26],
        readonly ["Shekalim", 33],
        readonly ["Megillah", 34],
        readonly ["Chagigah", 22],
        readonly ["Moed Katan", 19],
        readonly ["Yevamot", 85],
        readonly ["Ketubot", 72],
        readonly ["Sotah", 47],
        readonly ["Nedarim", 40],
        readonly ["Nazir", 47],
        readonly ["Gittin", 54],
        readonly ["Kiddushin", 48],
        readonly ["Bava Kamma", 44],
        readonly ["Bava Metzia", 37],
        readonly ["Bava Batra", 34],
        readonly ["Shevuot", 44],
        readonly ["Makkot", 9],
        readonly ["Sanhedrin", 57],
        readonly ["Avodah Zarah", 37],
        readonly ["Horayot", 19],
        readonly ["Niddah", 13],
    ];
    skipYK9Av: true;
    startAbs: number;
    startDate: Date;
} = ...

Yerushalmi Yomi configuration for Vilna Edition

+

Type declaration

  • Readonlyed: "vilna"
  • Readonlyshas: readonly [
        readonly ["Berakhot", 68],
        readonly ["Peah", 37],
        readonly ["Demai", 34],
        readonly ["Kilayim", 44],
        readonly ["Sheviit", 31],
        readonly ["Terumot", 59],
        readonly ["Maasrot", 26],
        readonly ["Maaser Sheni", 33],
        readonly ["Challah", 28],
        readonly ["Orlah", 20],
        readonly ["Bikkurim", 13],
        readonly ["Shabbat", 92],
        readonly ["Eruvin", 65],
        readonly ["Pesachim", 71],
        readonly ["Beitzah", 22],
        readonly ["Rosh Hashanah", 22],
        readonly ["Yoma", 42],
        readonly ["Sukkah", 26],
        readonly ["Taanit", 26],
        readonly ["Shekalim", 33],
        readonly ["Megillah", 34],
        readonly ["Chagigah", 22],
        readonly ["Moed Katan", 19],
        readonly ["Yevamot", 85],
        readonly ["Ketubot", 72],
        readonly ["Sotah", 47],
        readonly ["Nedarim", 40],
        readonly ["Nazir", 47],
        readonly ["Gittin", 54],
        readonly ["Kiddushin", 48],
        readonly ["Bava Kamma", 44],
        readonly ["Bava Metzia", 37],
        readonly ["Bava Batra", 34],
        readonly ["Shevuot", 44],
        readonly ["Makkot", 9],
        readonly ["Sanhedrin", 57],
        readonly ["Avodah Zarah", 37],
        readonly ["Horayot", 19],
        readonly ["Niddah", 13],
    ]
  • ReadonlyskipYK9Av: true
  • ReadonlystartAbs: number
  • ReadonlystartDate: Date

Settings

Member Visibility