From 7fe07fbec7933d9e5ba63686c320b12ece25b3ed Mon Sep 17 00:00:00 2001 From: "Michael J. Radwin" Date: Sun, 7 Jul 2024 08:44:12 -0700 Subject: [PATCH] Add API index --- api/index.html | 61 + api/rest-api/.nojekyll | 1 + api/rest-api/assets/highlight.css | 85 + api/rest-api/assets/icons.js | 18 + api/rest-api/assets/icons.svg | 1 + api/rest-api/assets/main.js | 60 + api/rest-api/assets/navigation.js | 1 + api/rest-api/assets/search.js | 1 + api/rest-api/assets/style.css | 1448 +++++++++++++++++ .../functions/appendIsraelAndTracking.html | 2 + .../functions/eventToClassicApiObject.html | 2 + api/rest-api/functions/eventToCsv.html | 2 + .../functions/eventToFullCalendar.html | 2 + api/rest-api/functions/eventToRssItem2.html | 1 + .../functions/eventsToClassicApi.html | 2 + api/rest-api/functions/eventsToCsv.html | 1 + api/rest-api/functions/eventsToRss2.html | 1 + api/rest-api/functions/getCalendarTitle.html | 2 + .../functions/getDownloadFilename.html | 1 + .../functions/getEventCategories.html | 2 + .../functions/getHolidayDescription.html | 2 + .../functions/locationToPlainObj.html | 2 + api/rest-api/functions/makeAnchor.html | 6 + api/rest-api/functions/makeMemo.html | 1 + api/rest-api/functions/makeTorahMemoText.html | 2 + api/rest-api/functions/pad2.html | 3 + api/rest-api/functions/pad4.html | 5 + .../functions/renderTitleWithoutTime.html | 2 + api/rest-api/functions/shouldRenderBrief.html | 1 + api/rest-api/functions/toISOString.html | 2 + api/rest-api/index.html | 9 + api/rest-api/interfaces/StringMap.html | 1 + api/rest-api/modules.html | 28 + api/rest-api/types/LocationPlainObj.html | 2 + api/rest-api/types/RestApiEventOptions.html | 1 + api/rest-api/types/RestApiOptions.html | 1 + api/rest-api/variables/countryNames.html | 1 + .../variables/holidayDescription.html | 1 + 38 files changed, 1764 insertions(+) create mode 100644 api/index.html create mode 100644 api/rest-api/.nojekyll create mode 100644 api/rest-api/assets/highlight.css create mode 100644 api/rest-api/assets/icons.js create mode 100644 api/rest-api/assets/icons.svg create mode 100644 api/rest-api/assets/main.js create mode 100644 api/rest-api/assets/navigation.js create mode 100644 api/rest-api/assets/search.js create mode 100644 api/rest-api/assets/style.css create mode 100644 api/rest-api/functions/appendIsraelAndTracking.html create mode 100644 api/rest-api/functions/eventToClassicApiObject.html create mode 100644 api/rest-api/functions/eventToCsv.html create mode 100644 api/rest-api/functions/eventToFullCalendar.html create mode 100644 api/rest-api/functions/eventToRssItem2.html create mode 100644 api/rest-api/functions/eventsToClassicApi.html create mode 100644 api/rest-api/functions/eventsToCsv.html create mode 100644 api/rest-api/functions/eventsToRss2.html create mode 100644 api/rest-api/functions/getCalendarTitle.html create mode 100644 api/rest-api/functions/getDownloadFilename.html create mode 100644 api/rest-api/functions/getEventCategories.html create mode 100644 api/rest-api/functions/getHolidayDescription.html create mode 100644 api/rest-api/functions/locationToPlainObj.html create mode 100644 api/rest-api/functions/makeAnchor.html create mode 100644 api/rest-api/functions/makeMemo.html create mode 100644 api/rest-api/functions/makeTorahMemoText.html create mode 100644 api/rest-api/functions/pad2.html create mode 100644 api/rest-api/functions/pad4.html create mode 100644 api/rest-api/functions/renderTitleWithoutTime.html create mode 100644 api/rest-api/functions/shouldRenderBrief.html create mode 100644 api/rest-api/functions/toISOString.html create mode 100644 api/rest-api/index.html create mode 100644 api/rest-api/interfaces/StringMap.html create mode 100644 api/rest-api/modules.html create mode 100644 api/rest-api/types/LocationPlainObj.html create mode 100644 api/rest-api/types/RestApiEventOptions.html create mode 100644 api/rest-api/types/RestApiOptions.html create mode 100644 api/rest-api/variables/countryNames.html create mode 100644 api/rest-api/variables/holidayDescription.html diff --git a/api/index.html b/api/index.html new file mode 100644 index 0000000..e78eae9 --- /dev/null +++ b/api/index.html @@ -0,0 +1,61 @@ + + + + + +Hebcal API Documentation + + + + + +
+ + +

Hebcal API Documentation

+
+ +
+ +

JavaScript / TypeScript

+ + +

Golang

+ +
+ + + + + diff --git a/api/rest-api/.nojekyll b/api/rest-api/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/api/rest-api/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/api/rest-api/assets/highlight.css b/api/rest-api/assets/highlight.css new file mode 100644 index 0000000..c7af87d --- /dev/null +++ b/api/rest-api/assets/highlight.css @@ -0,0 +1,85 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +pre, code { background: var(--code-background); } diff --git a/api/rest-api/assets/icons.js b/api/rest-api/assets/icons.js new file mode 100644 index 0000000..e88e8ca --- /dev/null +++ b/api/rest-api/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/api/rest-api/assets/icons.svg b/api/rest-api/assets/icons.svg new file mode 100644 index 0000000..e371b8b --- /dev/null +++ b/api/rest-api/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/api/rest-api/assets/main.js b/api/rest-api/assets/main.js new file mode 100644 index 0000000..7d7f77a --- /dev/null +++ b/api/rest-api/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Ce=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),Ve(t,i,r,e)}function Ve(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?He(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function He(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",H="mouseup",J={x:0,y:0},me=!1,ne=!1,je=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",H="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var qe=new U;Object.defineProperty(window,"app",{value:qe});fe();we();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/api/rest-api/assets/navigation.js b/api/rest-api/assets/navigation.js new file mode 100644 index 0000000..1372a43 --- /dev/null +++ b/api/rest-api/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE53VTW/bMAwG4P+ic7psadphuWXpigVYlyE1sMOwAyMxsRpZMkQ6azDsvw9OP+IPWTZ6FV8+hghJ/vVXMD6ymIl79tru7iAXI5EDp2ImtGX0W5BI49fqu5QzI0Zir60Ss8nV9b/RK/HNSWDt7A8D2q42D2eJjznSuFlvWO8/ffxwNal4aySe5/rLAS2v8rKTmmQgMlCNgwMt6QrL/vgdMqxIB/AaNgZpXK3XrcsqkzqjFRxvkKTXpy+HsHYqQkKeo1VL8oBmblXiQe613Z3dbWHlaY/jjmgdv55WcCzHnbiFASIty3FtHlByCO+IDsDpEPPo0E/cFsYswKBV4CNWNdaPromWjNkkAr5E+jCqzqXTq6WGkJHB0aDJ0WkL3Tt8rkeYHfLLRBPNBkNUMxPnbtwfaxyoW23QQtYlNmNx9PRsLIBx57yu3uCa2UjFya+Rq1xT28EIbJ5fzsS139az2k5FyAz2OLcydcGrca72EHeYuS6grPW0J85DWuaScq3DqYUiYA4qeGjL9WbbSMjyUpXvPqkLTRf4yOgtGFEHpx3g9E2gR6vw6bj/1Jy6ghMdPsvhZGTzlLrCqPWp7bPXuA2prVAEZLe8Xz3990NUpdxCfv8HLI0fy1cIAAA=" \ No newline at end of file diff --git a/api/rest-api/assets/search.js b/api/rest-api/assets/search.js new file mode 100644 index 0000000..034cb19 --- /dev/null +++ b/api/rest-api/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE62bW2/bOhLHvwv3VUjCmy9562m3OAW226LN7j4YQSFLTMxTXQyJSk8a5LsvKMnW0Bz7kD16SmBx/hyOfhxSvLyQpv7RktvNC/muq5zcLkRCqrRU5JaoJ1WZu/pt+0QS0jUFuSUPXZUZXVft9fTwamfKgiQkK9K2VS25JeQ1OSfXXtRrowSLOkut8V39uUh19Wn7B6LrFwqVL9Pv6k2V7eoGkZ0ehso9KvOu/lEVdZq/14Xqf/V1kVKhFZj6w9dPX02jq0dEGDyN8Pif9q28TY16rButWtzhk0Kh8o2qctXcaVOo/2mzqztzp9GY4AUjWvE2LVSVp4ME3ganSIT073Wh8/T5nWqzRu+tHK7vl4vB8K5u0t1HVdZ36k9zhkanTIy4tTmjaR+FSqX7varyD22TquJNld81afYdR/FMydCK2l3dFfmXHorfGq0ekCq8MhfFmVwc1Ycu8jHdH1V1ZVTzkGaqvT4+vCx3s15SyY6SX1Rr3ux1300+9e9+6kjmea/aa6TE5WhIySeXv32zKoGS/ziWBsoJ2aeNqswZZ6eK6Q2bXkRnyq9112SRVV9Bu2Anrka/z/vyUeW6K+N9OdrN6MvbtNyn+rGK9wZYzuXP0N9+V9tG/birv3bbP1RmIj07pzGXj8/prvmpdKxbwGwuT9pua3P0NpZqaDeXLzv1LjXqc9qY0Ixx8Ma1nMsfXWVFl6veItKhE9O5PFJdU0d6MprM5YFxJhVhLhxs5vIhR6YfYZ64lrP5kz6/r5syjYUE2s3lS5nq6j9NEenJZDVbXlHFQ7wfk9Vcfmw7XeQ2OUR6Au3m8qVIW/PbL/pzajtbRnn63G1/wR9oN198wAQ6NCy9yd/w4Mz09eLMNWTSeqr7r/HL3Pt4H5RPH//dCTGq91ezYc/HiEHgUoV/MQJ4ppcxybR5jql8LD9L3eanzqMaPpSfpe4iNdp0eVTggc08PtTVY7wTwGgeArKo95/NVm/dVaaJg+9oMosHaV7qisY4cLSYp/4209pZzAtxARjN4sWjOp0FX6x/KD5LzT/1PqbmofgsNbfGH6Qv1n0wmK/2f0e+d2g013u3/8WlYGj0q17waRzfnV8CfUobnW4L1V77hS6O50B+zBc2ai0iDB9H70TYcjp7s9eXNiSOhaLkoeEnd8XF30Q5KRnbji9tyy60wD6O9P1L234wqjyrOpWIFH7fFcVhrf28OCyFVXCfEF3l6k9y+0KeVNNa5m4Ju+JXa5KQB62K3O5pkUOKrctyWHbI66zr/70fi/1XZaZubOGh9PUNSTY3CV9crVbr+/tkczDuH/Q/HDSmX3pDSpINxQypZ0gdQ0aSDcMMmWfIHENOkg3HDLlnyB1DQZKNwAyFZygcQ0mSjcQMpWcoHcMFSTYLzHDhGS4cwyVJNkvMcOkZLh3DFUk2K8xw5RmuHMM1STZrzHDtGa5dACwPFGWH+vDQE3p6fHB+EIBcgqjlgqIMUR8i6lJELRsU5Yj6IFGXJGr5oChL1IeJujRRywhFeaI+UNQlilpO6CLh9Gq5oq6xDxV1qaKWFYpyRX2wqEsWtbxQlC3qw0VduqhlhqJ8UR8w6hLGLDMMJYz5hDGXMGaZYShhzCeMneSoPknhWQpJUy5hzDLDUMKYTxhzCWOWGYYSxnzCmEsYs8wwlDDmE8ZcwphlhqGEMZ8w5hLGLDMMJYz5hDGXMGaZYShhzCeMuYQxywxDCWM+YcwljFtmOEoY9wnjLmHcMsNRwrhPGHcJ45YZjhLGfcL4yUjYD4X4WIgMhi5h3DLDUcK4Txh3CeOWGY4Sxn3CuEsYt8xwdFzkPmHcJYwvzyZA7hPGXcL46izb3CeMu4RxywxH2eY+YdwlTPSEoWwLnzDhEiZ6wlC2hU+YcAkTlhmBsi18woRLmLDMCJRt4RMmTuZb/YQLZVsgUy6XMGGZESjbwidMuIQJy4zA53o+YcIlTFhmBMq28AkTLmHCMiNQtoVPmHAJE5YZgRImfMKES5i0zAiUMOkTJl3CpGVGoIRJnzDpEiYtMxIlTPqESZcwaZmRKGHSJ0y6hEnLjEQJkz5h8mRW30/rUcIkMrF3CZOWGYkSJn3CpEuYtMxI/IvCJ0y6hEnLjEQJkz5h40/9l+OTaozKPwxfkJvNcb/ghXwbPyvpcTPhhdAFuX15TQhf2r+v0+dk/+vxi9I+szUelhcnMcEnMSHDRPrjFrv+uIWp28Nxi0mT3Uya7CZCU/fHrtIqN8cDWqDZDDSbhalOS5mgxQK0eBGk028v5v0C3aTD6aTDaZCOXdsGjgABwcME+s0R4MMS+LAOkzgscQNHQGSFiFGphoWvSUqCNsmwNuXp88O4rw4QWgGEVmE6cI0PKIEQsbBeMhzCABISSIT1kWF5y9TZsHqW2lU8ECUQcBkW8KOgPaAMOgXoE1E6Tb8sB1wCvUKG9YpeCjax9jKBBNlFRkTOayfIKGEJZZR56IoiOy7pAcdADpVhfI2KTdvqYfURqAFAZCBjT/tu66UUEC4e1nv63RLQlYEnIswTsOIOdNagRWFkPSpziPS4gTzJgd4cFuxHZfLxqPnD8UA6cA+0MlSvf38ZOC4+yQEYwtB/VGbcNDiTdUD4wtLyTlkY9sOZOJB6ABEsjIjLjknQk2TYKDqejlPD6TjgG3gLLOw1DAdAAPBAgodKtAYfj0FS5WEtm/bbgQx4dSKM/MM1jr3dkartYREgB9jiYXAd5EyNCYJWBjZy2s8HHQhgIMJ07KkzuyUCfQGxYmGc25P76XhxBUQJBClYpuzvBoCxEA6GYW/Oyhh7N8Fqmf7+AtADMaJho85wG6RPfz+G2yBGu5kLzEbC0nOjWpPudd/76sMxJ+AkSPg0bIQdFRExDsR4mJg9A3hCBQdx42FxG65EDNHbDtcmQBMBHTQMj3E3HfAO4i7CSO01vIEHjGQysG39vYzSXtoAbQKJj4YlPnCGG/RAmA7C+rE3ODOQotjhezJsmDa1but2vNYFBhkQpDCdn+70g4Mwi7Awd6bMjtcTQKBBiqJhL74zZTleuwA6wCMaFpzOlO14lQToABBpWAaY7hGAdwZyHQvLdf3pFkAyeOsioEH3CdnrvSp0pcjt5v719f8kBMlDnjkAAA=="; \ No newline at end of file diff --git a/api/rest-api/assets/style.css b/api/rest-api/assets/style.css new file mode 100644 index 0000000..9d619a6 --- /dev/null +++ b/api/rest-api/assets/style.css @@ -0,0 +1,1448 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-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: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-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-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-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: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-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) { + :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-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-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --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-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); + } +} + +@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-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-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --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-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); + } +} + +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-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --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-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); +} + +: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-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --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-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); +} + +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +footer > p { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@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); +} + +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); +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + 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; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.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-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-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; +} + +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-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-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); +} + +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; +} + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.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-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-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-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.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-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.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; +} + +.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; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.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-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-literal { + color: var(--color-ts-type-literal); +} +.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); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* 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 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/api/rest-api/functions/appendIsraelAndTracking.html b/api/rest-api/functions/appendIsraelAndTracking.html new file mode 100644 index 0000000..07a20d4 --- /dev/null +++ b/api/rest-api/functions/appendIsraelAndTracking.html @@ -0,0 +1,2 @@ +appendIsraelAndTracking | @hebcal/rest-api

Function appendIsraelAndTracking

  • appendIsraelAndTracking(url, il, utmSource, utmMedium, utmCampaign?): string

  • Appends utm_source and utm_medium parameters to a URL

    +

    Parameters

    • url: string
    • il: boolean
    • utmSource: string
    • utmMedium: string
    • OptionalutmCampaign: string

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventToClassicApiObject.html b/api/rest-api/functions/eventToClassicApiObject.html new file mode 100644 index 0000000..d42b0bd --- /dev/null +++ b/api/rest-api/functions/eventToClassicApiObject.html @@ -0,0 +1,2 @@ +eventToClassicApiObject | @hebcal/rest-api

Function eventToClassicApiObject

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventToCsv.html b/api/rest-api/functions/eventToCsv.html new file mode 100644 index 0000000..306f767 --- /dev/null +++ b/api/rest-api/functions/eventToCsv.html @@ -0,0 +1,2 @@ +eventToCsv | @hebcal/rest-api

Function eventToCsv

  • eventToCsv(ev, options): string

  • Renders an Event as a string

    +

    Parameters

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventToFullCalendar.html b/api/rest-api/functions/eventToFullCalendar.html new file mode 100644 index 0000000..48021be --- /dev/null +++ b/api/rest-api/functions/eventToFullCalendar.html @@ -0,0 +1,2 @@ +eventToFullCalendar | @hebcal/rest-api

Function eventToFullCalendar

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventToRssItem2.html b/api/rest-api/functions/eventToRssItem2.html new file mode 100644 index 0000000..0d3fa14 --- /dev/null +++ b/api/rest-api/functions/eventToRssItem2.html @@ -0,0 +1 @@ +eventToRssItem2 | @hebcal/rest-api

Function eventToRssItem2

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventsToClassicApi.html b/api/rest-api/functions/eventsToClassicApi.html new file mode 100644 index 0000000..a89bdb9 --- /dev/null +++ b/api/rest-api/functions/eventsToClassicApi.html @@ -0,0 +1,2 @@ +eventsToClassicApi | @hebcal/rest-api

Function eventsToClassicApi

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventsToCsv.html b/api/rest-api/functions/eventsToCsv.html new file mode 100644 index 0000000..8614453 --- /dev/null +++ b/api/rest-api/functions/eventsToCsv.html @@ -0,0 +1 @@ +eventsToCsv | @hebcal/rest-api

Function eventsToCsv

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/eventsToRss2.html b/api/rest-api/functions/eventsToRss2.html new file mode 100644 index 0000000..597793f --- /dev/null +++ b/api/rest-api/functions/eventsToRss2.html @@ -0,0 +1 @@ +eventsToRss2 | @hebcal/rest-api

Function eventsToRss2

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/getCalendarTitle.html b/api/rest-api/functions/getCalendarTitle.html new file mode 100644 index 0000000..20d01ac --- /dev/null +++ b/api/rest-api/functions/getCalendarTitle.html @@ -0,0 +1,2 @@ +getCalendarTitle | @hebcal/rest-api

Function getCalendarTitle

  • getCalendarTitle(events, options): string

  • Generates a title like "Hebcal 2020 Israel" or "Hebcal May 1993 Providence"

    +

    Parameters

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/getDownloadFilename.html b/api/rest-api/functions/getDownloadFilename.html new file mode 100644 index 0000000..21cbfaa --- /dev/null +++ b/api/rest-api/functions/getDownloadFilename.html @@ -0,0 +1 @@ +getDownloadFilename | @hebcal/rest-api

Function getDownloadFilename

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/getEventCategories.html b/api/rest-api/functions/getEventCategories.html new file mode 100644 index 0000000..34a4cb5 --- /dev/null +++ b/api/rest-api/functions/getEventCategories.html @@ -0,0 +1,2 @@ +getEventCategories | @hebcal/rest-api

Function getEventCategories

  • getEventCategories(ev): string[]

  • Returns a category and subcategory name

    +

    Parameters

    • ev: Event

    Returns string[]

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/getHolidayDescription.html b/api/rest-api/functions/getHolidayDescription.html new file mode 100644 index 0000000..995c2f2 --- /dev/null +++ b/api/rest-api/functions/getHolidayDescription.html @@ -0,0 +1,2 @@ +getHolidayDescription | @hebcal/rest-api

Function getHolidayDescription

  • getHolidayDescription(ev, firstSentence?): string

  • Returns an English language description of the holiday

    +

    Parameters

    • ev: Event
    • firstSentence: boolean = false

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/locationToPlainObj.html b/api/rest-api/functions/locationToPlainObj.html new file mode 100644 index 0000000..62d513f --- /dev/null +++ b/api/rest-api/functions/locationToPlainObj.html @@ -0,0 +1,2 @@ +locationToPlainObj | @hebcal/rest-api

Function locationToPlainObj

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/makeAnchor.html b/api/rest-api/functions/makeAnchor.html new file mode 100644 index 0000000..2fe47f6 --- /dev/null +++ b/api/rest-api/functions/makeAnchor.html @@ -0,0 +1,6 @@ +makeAnchor | @hebcal/rest-api

Function makeAnchor

  • makeAnchor(s): string

  • Helper function to transform a string to make it more usable in a URL or filename. +Converts to lowercase and replaces non-word characters with hyphen ('-').

    +

    Parameters

    • s: string

    Returns string

    Example

    makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
+
    + +

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/makeMemo.html b/api/rest-api/functions/makeMemo.html new file mode 100644 index 0000000..e51f5b4 --- /dev/null +++ b/api/rest-api/functions/makeMemo.html @@ -0,0 +1 @@ +makeMemo | @hebcal/rest-api

Function makeMemo

  • makeMemo(ev, il): string

  • Parameters

    • ev: Event
    • il: boolean

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/makeTorahMemoText.html b/api/rest-api/functions/makeTorahMemoText.html new file mode 100644 index 0000000..e0031c8 --- /dev/null +++ b/api/rest-api/functions/makeTorahMemoText.html @@ -0,0 +1,2 @@ +makeTorahMemoText | @hebcal/rest-api

Function makeTorahMemoText

  • makeTorahMemoText(ev, il): string

  • Makes mulit-line text that summarizes Torah & Haftarah

    +

    Parameters

    • ev: Event
    • il: boolean

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/pad2.html b/api/rest-api/functions/pad2.html new file mode 100644 index 0000000..7f014ef --- /dev/null +++ b/api/rest-api/functions/pad2.html @@ -0,0 +1,3 @@ +pad2 | @hebcal/rest-api

Function pad2

  • pad2(number): string

  • Formats a number with leading zeros so the resulting string is 2 digits long. +Similar to string.padStart(2, '0').

    +

    Parameters

    • number: number

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/pad4.html b/api/rest-api/functions/pad4.html new file mode 100644 index 0000000..55b0fbc --- /dev/null +++ b/api/rest-api/functions/pad4.html @@ -0,0 +1,5 @@ +pad4 | @hebcal/rest-api

Function pad4

  • pad4(number): string

  • Formats a number with leading zeros so the resulting string is 4 digits long. +Similar to string.padStart(4, '0') but will also format +negative numbers similar to how the JavaScript date formats +negative year numbers (e.g. -37 is formatted as -000037).

    +

    Parameters

    • number: number

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/renderTitleWithoutTime.html b/api/rest-api/functions/renderTitleWithoutTime.html new file mode 100644 index 0000000..5c0ee68 --- /dev/null +++ b/api/rest-api/functions/renderTitleWithoutTime.html @@ -0,0 +1,2 @@ +renderTitleWithoutTime | @hebcal/rest-api

Function renderTitleWithoutTime

  • renderTitleWithoutTime(ev): string

  • Renders the event title in default locale, but strips off time

    +

    Parameters

    • ev: Event

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/shouldRenderBrief.html b/api/rest-api/functions/shouldRenderBrief.html new file mode 100644 index 0000000..03cb954 --- /dev/null +++ b/api/rest-api/functions/shouldRenderBrief.html @@ -0,0 +1 @@ +shouldRenderBrief | @hebcal/rest-api

Function shouldRenderBrief

  • shouldRenderBrief(ev): boolean

  • Parameters

    • ev: Event

    Returns boolean

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/functions/toISOString.html b/api/rest-api/functions/toISOString.html new file mode 100644 index 0000000..03b07d9 --- /dev/null +++ b/api/rest-api/functions/toISOString.html @@ -0,0 +1,2 @@ +toISOString | @hebcal/rest-api

Function toISOString

  • toISOString(d): string

  • Returns just the date portion as YYYY-MM-DD

    +

    Parameters

    • d: Date

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/index.html b/api/rest-api/index.html new file mode 100644 index 0000000..d935574 --- /dev/null +++ b/api/rest-api/index.html @@ -0,0 +1,9 @@ +@hebcal/rest-api

@hebcal/rest-api

@hebcal/rest-api

Jewish holidays and Hebrew calendar as plain JSON objects, RSS, and CSV export

+

Build Status

+

Installation

$ npm install @hebcal/rest-api
+
+ +

Synopsis

import {HebrewCalendar, Location} from '@hebcal/core';
import {eventsToClassicApi, eventsToCsv} from '@hebcal/rest-api';

const options = {
  year: 2020,
  month: 2,
  sedrot: true,
  candlelighting: true,
  location: Location.lookup('Hawaii'),
};
const events = HebrewCalendar.calendar(options);
const apiResult = eventsToClassicApi(events, options);

console.log(JSON.stringify(apiResult));

const csv = eventsToCsv(events, options);
console.log(JSON.stringify(csv));
+
+ +

API Documentation

Settings

Member Visibility

On This Page

@hebcal/rest-api
\ No newline at end of file diff --git a/api/rest-api/interfaces/StringMap.html b/api/rest-api/interfaces/StringMap.html new file mode 100644 index 0000000..5de0e5f --- /dev/null +++ b/api/rest-api/interfaces/StringMap.html @@ -0,0 +1 @@ +StringMap | @hebcal/rest-api

Interface StringMap

Indexable

  • [key: string]: string

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/modules.html b/api/rest-api/modules.html new file mode 100644 index 0000000..1cd9bc1 --- /dev/null +++ b/api/rest-api/modules.html @@ -0,0 +1,28 @@ +@hebcal/rest-api

@hebcal/rest-api

Index

Interfaces

StringMap +

Type Aliases

LocationPlainObj +RestApiEventOptions +RestApiOptions +

Variables

countryNames +holidayDescription +

Functions

appendIsraelAndTracking +eventToClassicApiObject +eventToCsv +eventToFullCalendar +eventToRssItem2 +eventsToClassicApi +eventsToCsv +eventsToRss2 +getCalendarTitle +getDownloadFilename +getEventCategories +getHolidayDescription +locationToPlainObj +makeAnchor +makeMemo +makeTorahMemoText +pad2 +pad4 +renderTitleWithoutTime +shouldRenderBrief +toISOString +

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/types/LocationPlainObj.html b/api/rest-api/types/LocationPlainObj.html new file mode 100644 index 0000000..b898066 --- /dev/null +++ b/api/rest-api/types/LocationPlainObj.html @@ -0,0 +1,2 @@ +LocationPlainObj | @hebcal/rest-api

Type Alias LocationPlainObj

LocationPlainObj: {
    admin1?: string;
    asciiname?: string;
    cc?: string;
    city?: string | null;
    country?: string;
    geo?: string;
    geonameid?: number;
    latitude?: number;
    longitude?: number;
    state?: string;
    stateName?: string;
    title?: string | null;
    tzid?: string;
    zip?: string;
}

Location information

+

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/types/RestApiEventOptions.html b/api/rest-api/types/RestApiEventOptions.html new file mode 100644 index 0000000..8c838a5 --- /dev/null +++ b/api/rest-api/types/RestApiEventOptions.html @@ -0,0 +1 @@ +RestApiEventOptions | @hebcal/rest-api

Type Alias RestApiEventOptions

RestApiEventOptions: {
    appendHebrewToSubject?: boolean;
    buildDate?: Date;
    dayFormat?: Intl.DateTimeFormat;
    description?: string;
    euro?: boolean;
    evPubDate?: boolean;
    heDateParts?: boolean;
    includeEvent?: boolean;
    lang?: string;
    lastBuildDate?: string;
    mainUrl?: string;
    selfUrl?: string;
    subscribe?: string | boolean;
    title?: string;
    utmCampaign?: string;
    utmMedium?: string;
    utmSource?: string;
    yahrzeit?: boolean;
}

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/types/RestApiOptions.html b/api/rest-api/types/RestApiOptions.html new file mode 100644 index 0000000..1ded7cc --- /dev/null +++ b/api/rest-api/types/RestApiOptions.html @@ -0,0 +1 @@ +RestApiOptions | @hebcal/rest-api

Type Alias RestApiOptions

RestApiOptions: CalOptions & RestApiEventOptions

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/variables/countryNames.html b/api/rest-api/variables/countryNames.html new file mode 100644 index 0000000..229ddf0 --- /dev/null +++ b/api/rest-api/variables/countryNames.html @@ -0,0 +1 @@ +countryNames | @hebcal/rest-api

Variable countryNamesConst

countryNames: StringMap = ...

Settings

Member Visibility
\ No newline at end of file diff --git a/api/rest-api/variables/holidayDescription.html b/api/rest-api/variables/holidayDescription.html new file mode 100644 index 0000000..e51e916 --- /dev/null +++ b/api/rest-api/variables/holidayDescription.html @@ -0,0 +1 @@ +holidayDescription | @hebcal/rest-api

Variable holidayDescriptionConst

holidayDescription: StringMap = ...

Settings

Member Visibility
\ No newline at end of file