diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 13888f9..dec52b2 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,12 +1,12 @@ :root { --light-hl-0: #000000; --dark-hl-0: #D4D4D4; - --light-hl-1: #AF00DB; - --dark-hl-1: #C586C0; - --light-hl-2: #001080; - --dark-hl-2: #9CDCFE; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; + --light-hl-1: #A31515; + --dark-hl-1: #CE9178; + --light-hl-2: #AF00DB; + --dark-hl-2: #C586C0; + --light-hl-3: #001080; + --dark-hl-3: #9CDCFE; --light-hl-4: #0000FF; --dark-hl-4: #569CD6; --light-hl-5: #267F99; diff --git a/docs/assets/main.js b/docs/assets/main.js index 0e05961..d55df03 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -2,3 +2,57 @@ "use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,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 h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}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(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+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),u=0;u1?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 ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.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()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n.tagName!=="SECTION";)n=n.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(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),e.blur()}}function fe(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(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +/*! 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/docs/assets/search.js b/docs/assets/search.js index 87b2b74..e6b9d69 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"check\",\"url\":\"functions/check.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"accumulate\",\"url\":\"functions/accumulate.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"filterByNotation\",\"url\":\"functions/filterByNotation.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"Ability\",\"url\":\"types/Ability.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Ability.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Ability\"},{\"kind\":1024,\"name\":\"subject\",\"url\":\"types/Ability.html#__type.subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"action\",\"url\":\"types/Ability.html#__type.action\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"object\",\"url\":\"types/Ability.html#__type.object\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"field\",\"url\":\"types/Ability.html#__type.field\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"filter\",\"url\":\"types/Ability.html#__type.filter\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"location\",\"url\":\"types/Ability.html#__type.location\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"time\",\"url\":\"types/Ability.html#__type.time\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":4194304,\"name\":\"Time\",\"url\":\"types/Time.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Time.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Time\"},{\"kind\":1024,\"name\":\"cron_exp\",\"url\":\"types/Time.html#__type.cron_exp\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Time.__type\"},{\"kind\":1024,\"name\":\"duration\",\"url\":\"types/Time.html#__type.duration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Time.__type\"},{\"kind\":128,\"name\":\"Permission\",\"url\":\"classes/Permission.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Permission.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"times\",\"url\":\"classes/Permission.html#times\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"classes/Permission.html#fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"filters\",\"url\":\"classes/Permission.html#filters\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"locations\",\"url\":\"classes/Permission.html#locations\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"location\",\"url\":\"classes/Permission.html#location\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"time\",\"url\":\"classes/Permission.html#time\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"field\",\"url\":\"classes/Permission.html#field\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"filter\",\"url\":\"classes/Permission.html#filter\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"granted\",\"url\":\"classes/Permission.html#granted\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"grants\",\"url\":\"classes/Permission.html#grants\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"has\",\"url\":\"classes/Permission.html#has\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"grant\",\"url\":\"classes/Permission.html#grant\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasAny\",\"url\":\"classes/Permission.html#hasAny\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasScopeAny\",\"url\":\"classes/Permission.html#hasScopeAny\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasAll\",\"url\":\"classes/Permission.html#hasAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasScopeAll\",\"url\":\"classes/Permission.html#hasScopeAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"abilities\",\"url\":\"classes/Permission.html#abilities\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":256,\"name\":\"Grant\",\"url\":\"interfaces/Grant.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"subject\",\"url\":\"interfaces/Grant.html#subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"action\",\"url\":\"interfaces/Grant.html#action\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"object\",\"url\":\"interfaces/Grant.html#object\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"field\",\"url\":\"interfaces/Grant.html#field\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Grant.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"filter\",\"url\":\"interfaces/Grant.html#filter\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Grant.html#__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"location\",\"url\":\"interfaces/Grant.html#location\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Grant.html#__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"time\",\"url\":\"interfaces/Grant.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/Grant.html#__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"ability\",\"url\":\"interfaces/Grant.html#ability\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"Grant\"},{\"kind\":4194304,\"name\":\"PermissionGrant\",\"url\":\"types/PermissionGrant.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/PermissionGrant.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"PermissionGrant\"},{\"kind\":256,\"name\":\"AccessControlOption\",\"url\":\"interfaces/AccessControlOption.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"sep\",\"url\":\"interfaces/AccessControlOption.html#sep\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessControlOption\"},{\"kind\":1024,\"name\":\"strict\",\"url\":\"interfaces/AccessControlOption.html#strict\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessControlOption\"},{\"kind\":128,\"name\":\"default\",\"url\":\"classes/default.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/default.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"sep\",\"url\":\"classes/default.html#sep\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"strict\",\"url\":\"classes/default.html#strict\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"_abilities\",\"url\":\"classes/default.html#_abilities\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"default\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"_validators\",\"url\":\"classes/default.html#_validators\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"default\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"ip_cidr\",\"url\":\"classes/default.html#__type-1.ip_cidr\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"default.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#__type-1.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"default.__type\"},{\"kind\":1024,\"name\":\"cron\",\"url\":\"classes/default.html#__type-1.cron\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"default.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#__type-1.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"default.__type\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/default.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"update\",\"url\":\"classes/default.html#update\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"clear\",\"url\":\"classes/default.html#clear\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":262144,\"name\":\"abilities\",\"url\":\"classes/default.html#abilities\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"can\",\"url\":\"classes/default.html#can\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,38.572]],[\"comment/0\",[]],[\"name/1\",[1,38.572]],[\"comment/1\",[]],[\"name/2\",[2,38.572]],[\"comment/2\",[]],[\"name/3\",[3,33.464]],[\"comment/3\",[]],[\"name/4\",[4,18.203]],[\"comment/4\",[]],[\"name/5\",[5,33.464]],[\"comment/5\",[]],[\"name/6\",[6,33.464]],[\"comment/6\",[]],[\"name/7\",[7,33.464]],[\"comment/7\",[]],[\"name/8\",[8,30.099]],[\"comment/8\",[]],[\"name/9\",[9,30.099]],[\"comment/9\",[]],[\"name/10\",[10,30.099]],[\"comment/10\",[]],[\"name/11\",[11,27.586]],[\"comment/11\",[]],[\"name/12\",[11,27.586]],[\"comment/12\",[]],[\"name/13\",[4,18.203]],[\"comment/13\",[]],[\"name/14\",[12,38.572]],[\"comment/14\",[]],[\"name/15\",[13,38.572]],[\"comment/15\",[]],[\"name/16\",[14,38.572]],[\"comment/16\",[]],[\"name/17\",[15,33.464]],[\"comment/17\",[]],[\"name/18\",[16,38.572]],[\"comment/18\",[]],[\"name/19\",[17,38.572]],[\"comment/19\",[]],[\"name/20\",[18,38.572]],[\"comment/20\",[]],[\"name/21\",[19,38.572]],[\"comment/21\",[]],[\"name/22\",[10,30.099]],[\"comment/22\",[]],[\"name/23\",[11,27.586]],[\"comment/23\",[]],[\"name/24\",[8,30.099]],[\"comment/24\",[]],[\"name/25\",[9,30.099]],[\"comment/25\",[]],[\"name/26\",[20,38.572]],[\"comment/26\",[]],[\"name/27\",[21,38.572]],[\"comment/27\",[]],[\"name/28\",[22,38.572]],[\"comment/28\",[]],[\"name/29\",[23,33.464]],[\"comment/29\",[]],[\"name/30\",[24,38.572]],[\"comment/30\",[]],[\"name/31\",[25,38.572]],[\"comment/31\",[]],[\"name/32\",[26,38.572]],[\"comment/32\",[]],[\"name/33\",[27,38.572]],[\"comment/33\",[]],[\"name/34\",[28,33.464]],[\"comment/34\",[]],[\"name/35\",[23,33.464]],[\"comment/35\",[]],[\"name/36\",[5,33.464]],[\"comment/36\",[]],[\"name/37\",[6,33.464]],[\"comment/37\",[]],[\"name/38\",[7,33.464]],[\"comment/38\",[]],[\"name/39\",[8,30.099]],[\"comment/39\",[]],[\"name/40\",[4,18.203]],[\"comment/40\",[]],[\"name/41\",[9,30.099]],[\"comment/41\",[]],[\"name/42\",[4,18.203]],[\"comment/42\",[]],[\"name/43\",[10,30.099]],[\"comment/43\",[]],[\"name/44\",[4,18.203]],[\"comment/44\",[]],[\"name/45\",[11,27.586]],[\"comment/45\",[]],[\"name/46\",[4,18.203]],[\"comment/46\",[]],[\"name/47\",[3,33.464]],[\"comment/47\",[]],[\"name/48\",[29,38.572]],[\"comment/48\",[]],[\"name/49\",[4,18.203]],[\"comment/49\",[]],[\"name/50\",[30,38.572]],[\"comment/50\",[]],[\"name/51\",[31,33.464]],[\"comment/51\",[]],[\"name/52\",[32,33.464]],[\"comment/52\",[]],[\"name/53\",[33,38.572]],[\"comment/53\",[]],[\"name/54\",[15,33.464]],[\"comment/54\",[]],[\"name/55\",[31,33.464]],[\"comment/55\",[]],[\"name/56\",[32,33.464]],[\"comment/56\",[]],[\"name/57\",[34,38.572]],[\"comment/57\",[]],[\"name/58\",[4,18.203]],[\"comment/58\",[]],[\"name/59\",[35,38.572]],[\"comment/59\",[]],[\"name/60\",[4,18.203]],[\"comment/60\",[]],[\"name/61\",[36,38.572]],[\"comment/61\",[]],[\"name/62\",[4,18.203]],[\"comment/62\",[]],[\"name/63\",[37,38.572]],[\"comment/63\",[]],[\"name/64\",[4,18.203]],[\"comment/64\",[]],[\"name/65\",[38,38.572]],[\"comment/65\",[]],[\"name/66\",[39,38.572]],[\"comment/66\",[]],[\"name/67\",[40,38.572]],[\"comment/67\",[]],[\"name/68\",[28,33.464]],[\"comment/68\",[]],[\"name/69\",[41,38.572]],[\"comment/69\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"13\":{},\"40\":{},\"42\":{},\"44\":{},\"46\":{},\"49\":{},\"58\":{},\"60\":{},\"62\":{},\"64\":{}},\"comment\":{}}],[\"_abilities\",{\"_index\":34,\"name\":{\"57\":{}},\"comment\":{}}],[\"_validators\",{\"_index\":35,\"name\":{\"59\":{}},\"comment\":{}}],[\"abilities\",{\"_index\":28,\"name\":{\"34\":{},\"68\":{}},\"comment\":{}}],[\"ability\",{\"_index\":3,\"name\":{\"3\":{},\"47\":{}},\"comment\":{}}],[\"accesscontroloption\",{\"_index\":30,\"name\":{\"50\":{}},\"comment\":{}}],[\"accumulate\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"action\",{\"_index\":6,\"name\":{\"6\":{},\"37\":{}},\"comment\":{}}],[\"can\",{\"_index\":41,\"name\":{\"69\":{}},\"comment\":{}}],[\"check\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"clear\",{\"_index\":40,\"name\":{\"67\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":15,\"name\":{\"17\":{},\"54\":{}},\"comment\":{}}],[\"cron\",{\"_index\":37,\"name\":{\"63\":{}},\"comment\":{}}],[\"cron_exp\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"default\",{\"_index\":33,\"name\":{\"53\":{}},\"comment\":{}}],[\"duration\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"field\",{\"_index\":8,\"name\":{\"8\":{},\"24\":{},\"39\":{}},\"comment\":{}}],[\"fields\",{\"_index\":17,\"name\":{\"19\":{}},\"comment\":{}}],[\"filter\",{\"_index\":9,\"name\":{\"9\":{},\"25\":{},\"41\":{}},\"comment\":{}}],[\"filterbynotation\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"filters\",{\"_index\":18,\"name\":{\"20\":{}},\"comment\":{}}],[\"grant\",{\"_index\":23,\"name\":{\"29\":{},\"35\":{}},\"comment\":{}}],[\"granted\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"grants\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"has\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"hasall\",{\"_index\":26,\"name\":{\"32\":{}},\"comment\":{}}],[\"hasany\",{\"_index\":24,\"name\":{\"30\":{}},\"comment\":{}}],[\"hasscopeall\",{\"_index\":27,\"name\":{\"33\":{}},\"comment\":{}}],[\"hasscopeany\",{\"_index\":25,\"name\":{\"31\":{}},\"comment\":{}}],[\"ip_cidr\",{\"_index\":36,\"name\":{\"61\":{}},\"comment\":{}}],[\"location\",{\"_index\":10,\"name\":{\"10\":{},\"22\":{},\"43\":{}},\"comment\":{}}],[\"locations\",{\"_index\":19,\"name\":{\"21\":{}},\"comment\":{}}],[\"object\",{\"_index\":7,\"name\":{\"7\":{},\"38\":{}},\"comment\":{}}],[\"permission\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"permissiongrant\",{\"_index\":29,\"name\":{\"48\":{}},\"comment\":{}}],[\"sep\",{\"_index\":31,\"name\":{\"51\":{},\"55\":{}},\"comment\":{}}],[\"strict\",{\"_index\":32,\"name\":{\"52\":{},\"56\":{}},\"comment\":{}}],[\"subject\",{\"_index\":5,\"name\":{\"5\":{},\"36\":{}},\"comment\":{}}],[\"time\",{\"_index\":11,\"name\":{\"11\":{},\"12\":{},\"23\":{},\"45\":{}},\"comment\":{}}],[\"times\",{\"_index\":16,\"name\":{\"18\":{}},\"comment\":{}}],[\"update\",{\"_index\":39,\"name\":{\"66\":{}},\"comment\":{}}],[\"validate\",{\"_index\":38,\"name\":{\"65\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"check\",\"url\":\"functions/check.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"accumulate\",\"url\":\"functions/accumulate.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"filterByNotation\",\"url\":\"functions/filterByNotation.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"Ability\",\"url\":\"types/Ability.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Ability.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Ability\"},{\"kind\":1024,\"name\":\"subject\",\"url\":\"types/Ability.html#__type.subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"action\",\"url\":\"types/Ability.html#__type.action\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"object\",\"url\":\"types/Ability.html#__type.object\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"field\",\"url\":\"types/Ability.html#__type.field\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"filter\",\"url\":\"types/Ability.html#__type.filter\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"location\",\"url\":\"types/Ability.html#__type.location\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":1024,\"name\":\"time\",\"url\":\"types/Ability.html#__type.time\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Ability.__type\"},{\"kind\":4194304,\"name\":\"Time\",\"url\":\"types/Time.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Time.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Time\"},{\"kind\":1024,\"name\":\"cron_exp\",\"url\":\"types/Time.html#__type.cron_exp\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Time.__type\"},{\"kind\":1024,\"name\":\"duration\",\"url\":\"types/Time.html#__type.duration\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Time.__type\"},{\"kind\":128,\"name\":\"Permission\",\"url\":\"classes/Permission.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"build\",\"url\":\"classes/Permission.html#build\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Permission.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"times\",\"url\":\"classes/Permission.html#times\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"fields\",\"url\":\"classes/Permission.html#fields\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"filters\",\"url\":\"classes/Permission.html#filters\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"locations\",\"url\":\"classes/Permission.html#locations\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"location\",\"url\":\"classes/Permission.html#location\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"time\",\"url\":\"classes/Permission.html#time\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"field\",\"url\":\"classes/Permission.html#field\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"filter\",\"url\":\"classes/Permission.html#filter\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"granted\",\"url\":\"classes/Permission.html#granted\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":1024,\"name\":\"grants\",\"url\":\"classes/Permission.html#grants\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"has\",\"url\":\"classes/Permission.html#has\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"grant\",\"url\":\"classes/Permission.html#grant\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasAny\",\"url\":\"classes/Permission.html#hasAny\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasScopeAny\",\"url\":\"classes/Permission.html#hasScopeAny\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasAll\",\"url\":\"classes/Permission.html#hasAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"hasScopeAll\",\"url\":\"classes/Permission.html#hasScopeAll\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":2048,\"name\":\"abilities\",\"url\":\"classes/Permission.html#abilities\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Permission\"},{\"kind\":128,\"name\":\"Grant\",\"url\":\"classes/Grant.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"build\",\"url\":\"classes/Grant.html#build\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Grant.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"subject\",\"url\":\"classes/Grant.html#subject\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"action\",\"url\":\"classes/Grant.html#action\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"object\",\"url\":\"classes/Grant.html#object\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":1024,\"name\":\"ability\",\"url\":\"classes/Grant.html#ability\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":2048,\"name\":\"field\",\"url\":\"classes/Grant.html#field\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":2048,\"name\":\"filter\",\"url\":\"classes/Grant.html#filter\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":2048,\"name\":\"location\",\"url\":\"classes/Grant.html#location\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":2048,\"name\":\"time\",\"url\":\"classes/Grant.html#time\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Grant\"},{\"kind\":4194304,\"name\":\"PermissionGrant\",\"url\":\"types/PermissionGrant.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/PermissionGrant.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"PermissionGrant\"},{\"kind\":256,\"name\":\"AccessControlOption\",\"url\":\"interfaces/AccessControlOption.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"sep\",\"url\":\"interfaces/AccessControlOption.html#sep\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessControlOption\"},{\"kind\":1024,\"name\":\"strict\",\"url\":\"interfaces/AccessControlOption.html#strict\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccessControlOption\"},{\"kind\":128,\"name\":\"default\",\"url\":\"classes/default.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/default.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"sep\",\"url\":\"classes/default.html#sep\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"strict\",\"url\":\"classes/default.html#strict\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":1024,\"name\":\"_abilities\",\"url\":\"classes/default.html#_abilities\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"default\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#_abilities.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"default._abilities\"},{\"kind\":1024,\"name\":\"_validators\",\"url\":\"classes/default.html#_validators\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"default\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#_validators.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"default._validators\"},{\"kind\":1024,\"name\":\"ip_cidr\",\"url\":\"classes/default.html#_validators.__type-1.ip_cidr\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"default._validators.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#_validators.__type-1.ip_cidr.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"default._validators.__type.ip_cidr\"},{\"kind\":1024,\"name\":\"cron\",\"url\":\"classes/default.html#_validators.__type-1.cron\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"default._validators.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/default.html#_validators.__type-1.cron.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"default._validators.__type.cron\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/default.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"update\",\"url\":\"classes/default.html#update\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"clear\",\"url\":\"classes/default.html#clear\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":262144,\"name\":\"abilities\",\"url\":\"classes/default.html#abilities\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"default\"},{\"kind\":2048,\"name\":\"can\",\"url\":\"classes/default.html#can\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"default\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,38.43]],[\"comment/0\",[]],[\"name/1\",[1,38.43]],[\"comment/1\",[]],[\"name/2\",[2,38.43]],[\"comment/2\",[]],[\"name/3\",[3,33.322]],[\"comment/3\",[]],[\"name/4\",[4,22.336]],[\"comment/4\",[]],[\"name/5\",[5,33.322]],[\"comment/5\",[]],[\"name/6\",[6,33.322]],[\"comment/6\",[]],[\"name/7\",[7,33.322]],[\"comment/7\",[]],[\"name/8\",[8,29.957]],[\"comment/8\",[]],[\"name/9\",[9,29.957]],[\"comment/9\",[]],[\"name/10\",[10,29.957]],[\"comment/10\",[]],[\"name/11\",[11,27.444]],[\"comment/11\",[]],[\"name/12\",[11,27.444]],[\"comment/12\",[]],[\"name/13\",[4,22.336]],[\"comment/13\",[]],[\"name/14\",[12,38.43]],[\"comment/14\",[]],[\"name/15\",[13,38.43]],[\"comment/15\",[]],[\"name/16\",[14,38.43]],[\"comment/16\",[]],[\"name/17\",[15,33.322]],[\"comment/17\",[]],[\"name/18\",[16,29.957]],[\"comment/18\",[]],[\"name/19\",[17,38.43]],[\"comment/19\",[]],[\"name/20\",[18,38.43]],[\"comment/20\",[]],[\"name/21\",[19,38.43]],[\"comment/21\",[]],[\"name/22\",[20,38.43]],[\"comment/22\",[]],[\"name/23\",[10,29.957]],[\"comment/23\",[]],[\"name/24\",[11,27.444]],[\"comment/24\",[]],[\"name/25\",[8,29.957]],[\"comment/25\",[]],[\"name/26\",[9,29.957]],[\"comment/26\",[]],[\"name/27\",[21,38.43]],[\"comment/27\",[]],[\"name/28\",[22,38.43]],[\"comment/28\",[]],[\"name/29\",[23,38.43]],[\"comment/29\",[]],[\"name/30\",[24,33.322]],[\"comment/30\",[]],[\"name/31\",[25,38.43]],[\"comment/31\",[]],[\"name/32\",[26,38.43]],[\"comment/32\",[]],[\"name/33\",[27,38.43]],[\"comment/33\",[]],[\"name/34\",[28,38.43]],[\"comment/34\",[]],[\"name/35\",[29,33.322]],[\"comment/35\",[]],[\"name/36\",[24,33.322]],[\"comment/36\",[]],[\"name/37\",[15,33.322]],[\"comment/37\",[]],[\"name/38\",[16,29.957]],[\"comment/38\",[]],[\"name/39\",[5,33.322]],[\"comment/39\",[]],[\"name/40\",[6,33.322]],[\"comment/40\",[]],[\"name/41\",[7,33.322]],[\"comment/41\",[]],[\"name/42\",[3,33.322]],[\"comment/42\",[]],[\"name/43\",[8,29.957]],[\"comment/43\",[]],[\"name/44\",[9,29.957]],[\"comment/44\",[]],[\"name/45\",[10,29.957]],[\"comment/45\",[]],[\"name/46\",[11,27.444]],[\"comment/46\",[]],[\"name/47\",[30,38.43]],[\"comment/47\",[]],[\"name/48\",[4,22.336]],[\"comment/48\",[]],[\"name/49\",[31,38.43]],[\"comment/49\",[]],[\"name/50\",[32,33.322]],[\"comment/50\",[]],[\"name/51\",[33,33.322]],[\"comment/51\",[]],[\"name/52\",[34,38.43]],[\"comment/52\",[]],[\"name/53\",[16,29.957]],[\"comment/53\",[]],[\"name/54\",[32,33.322]],[\"comment/54\",[]],[\"name/55\",[33,33.322]],[\"comment/55\",[]],[\"name/56\",[35,38.43]],[\"comment/56\",[]],[\"name/57\",[4,22.336]],[\"comment/57\",[]],[\"name/58\",[36,38.43]],[\"comment/58\",[]],[\"name/59\",[4,22.336]],[\"comment/59\",[]],[\"name/60\",[37,38.43]],[\"comment/60\",[]],[\"name/61\",[4,22.336]],[\"comment/61\",[]],[\"name/62\",[38,38.43]],[\"comment/62\",[]],[\"name/63\",[4,22.336]],[\"comment/63\",[]],[\"name/64\",[39,38.43]],[\"comment/64\",[]],[\"name/65\",[40,38.43]],[\"comment/65\",[]],[\"name/66\",[41,38.43]],[\"comment/66\",[]],[\"name/67\",[29,33.322]],[\"comment/67\",[]],[\"name/68\",[42,38.43]],[\"comment/68\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":4,\"name\":{\"4\":{},\"13\":{},\"48\":{},\"57\":{},\"59\":{},\"61\":{},\"63\":{}},\"comment\":{}}],[\"_abilities\",{\"_index\":35,\"name\":{\"56\":{}},\"comment\":{}}],[\"_validators\",{\"_index\":36,\"name\":{\"58\":{}},\"comment\":{}}],[\"abilities\",{\"_index\":29,\"name\":{\"35\":{},\"67\":{}},\"comment\":{}}],[\"ability\",{\"_index\":3,\"name\":{\"3\":{},\"42\":{}},\"comment\":{}}],[\"accesscontroloption\",{\"_index\":31,\"name\":{\"49\":{}},\"comment\":{}}],[\"accumulate\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"action\",{\"_index\":6,\"name\":{\"6\":{},\"40\":{}},\"comment\":{}}],[\"build\",{\"_index\":15,\"name\":{\"17\":{},\"37\":{}},\"comment\":{}}],[\"can\",{\"_index\":42,\"name\":{\"68\":{}},\"comment\":{}}],[\"check\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"clear\",{\"_index\":41,\"name\":{\"66\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":16,\"name\":{\"18\":{},\"38\":{},\"53\":{}},\"comment\":{}}],[\"cron\",{\"_index\":38,\"name\":{\"62\":{}},\"comment\":{}}],[\"cron_exp\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"default\",{\"_index\":34,\"name\":{\"52\":{}},\"comment\":{}}],[\"duration\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"field\",{\"_index\":8,\"name\":{\"8\":{},\"25\":{},\"43\":{}},\"comment\":{}}],[\"fields\",{\"_index\":18,\"name\":{\"20\":{}},\"comment\":{}}],[\"filter\",{\"_index\":9,\"name\":{\"9\":{},\"26\":{},\"44\":{}},\"comment\":{}}],[\"filterbynotation\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"filters\",{\"_index\":19,\"name\":{\"21\":{}},\"comment\":{}}],[\"grant\",{\"_index\":24,\"name\":{\"30\":{},\"36\":{}},\"comment\":{}}],[\"granted\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"grants\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"has\",{\"_index\":23,\"name\":{\"29\":{}},\"comment\":{}}],[\"hasall\",{\"_index\":27,\"name\":{\"33\":{}},\"comment\":{}}],[\"hasany\",{\"_index\":25,\"name\":{\"31\":{}},\"comment\":{}}],[\"hasscopeall\",{\"_index\":28,\"name\":{\"34\":{}},\"comment\":{}}],[\"hasscopeany\",{\"_index\":26,\"name\":{\"32\":{}},\"comment\":{}}],[\"ip_cidr\",{\"_index\":37,\"name\":{\"60\":{}},\"comment\":{}}],[\"location\",{\"_index\":10,\"name\":{\"10\":{},\"23\":{},\"45\":{}},\"comment\":{}}],[\"locations\",{\"_index\":20,\"name\":{\"22\":{}},\"comment\":{}}],[\"object\",{\"_index\":7,\"name\":{\"7\":{},\"41\":{}},\"comment\":{}}],[\"permission\",{\"_index\":14,\"name\":{\"16\":{}},\"comment\":{}}],[\"permissiongrant\",{\"_index\":30,\"name\":{\"47\":{}},\"comment\":{}}],[\"sep\",{\"_index\":32,\"name\":{\"50\":{},\"54\":{}},\"comment\":{}}],[\"strict\",{\"_index\":33,\"name\":{\"51\":{},\"55\":{}},\"comment\":{}}],[\"subject\",{\"_index\":5,\"name\":{\"5\":{},\"39\":{}},\"comment\":{}}],[\"time\",{\"_index\":11,\"name\":{\"11\":{},\"12\":{},\"24\":{},\"46\":{}},\"comment\":{}}],[\"times\",{\"_index\":17,\"name\":{\"19\":{}},\"comment\":{}}],[\"update\",{\"_index\":40,\"name\":{\"65\":{}},\"comment\":{}}],[\"validate\",{\"_index\":39,\"name\":{\"64\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/classes/Grant.html b/docs/classes/Grant.html new file mode 100644 index 0000000..7b7d7c0 --- /dev/null +++ b/docs/classes/Grant.html @@ -0,0 +1,287 @@ +Grant | abacl
+
+ +
+
+
+
+ +

Class Grant<S, Act, Obj>

+
+

Type Parameters

+
    +
  • +

    S = string

  • +
  • +

    Act = string

  • +
  • +

    Obj = string

+
+

Hierarchy

+
    +
  • Grant
+
+
+
+ +
+
+

Constructors

+
+
+

Properties

+
+
+

Methods

+
+
+

Constructors

+
+ +
    + +
  • +

    The constructor function takes an ability object and sets the ability, action, object, and subject +properties of the new instance to the corresponding properties of the ability object

    +
    +
    +

    Type Parameters

    +
      +
    • +

      S = string

    • +
    • +

      Act = string

    • +
    • +

      Obj = string

    +
    +

    Parameters

    +
      +
    • +
      ability: Ability<S, Act, Obj>
      +

      Ability<S, Act, Obj>

      +
    +

    Returns Grant<S, Act, Obj>

+
+

Properties

+
+ +
ability: Ability<S, Act, Obj>
+
+ +
action: "any" | Act
+
+ +
object: "all" | Obj
+
+ +
subject: S
+
+

Methods

+
+ +
    + +
  • +

    It takes a data object and returns a filtered version of it based on the field notation

    + +

    Returns

    The return type is a Partial | Partial[].

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = unknown

    +
    +

    Parameters

    +
      +
    • +
      data: T
      +

      The data to filter.

      +
    • +
    • +
      Optional deep_copy: boolean = false
      +

      If true, the returned data will be a deep copy of the original data.

      +
    +

    Returns Partial<T> | Partial<T>[]

+
+ +
    + +
  • +

    It takes a data object and returns a filtered version of it based on the filter notation

    + +

    Returns

    A partial of the data that is passed in.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T = unknown

    +
    +

    Parameters

    +
      +
    • +
      data: T
      +

      The data to be filtered.

      +
    • +
    • +
      Optional deep_copy: boolean = false
      +

      If true, the data will be deep copied before filtering.

      +
    +

    Returns Partial<T> | Partial<T>[]

+
+ +
    + +
  • +

    It checks if the IP address is in the list of allowed IP addresses

    + +

    Returns

    A boolean value.

    +
    +
    +

    Parameters

    +
      +
    • +
      ip: string
      +

      The IP address to check.

      +
    • +
    • +
      Optional strict: boolean = false
      +

      If true, the user must be in the location list. If false, the user must be +in the location list or the list must be empty.

      +
    +

    Returns boolean

+
+ +
    + +
  • +

    If the ability has a time property, check if the current time matches any of the time objects in +the array

    + +

    Returns

    A boolean value.

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional options: {
          currentDate?: Date;
          tz?: string;
      }
      +

      An object with the following properties:

      +
      +
        +
      • +
        Optional currentDate?: Date
      • +
      • +
        Optional tz?: string
    • +
    • +
      Optional strict: boolean = false
      +

      If true, the ability will only be active if the time is explicitly set. If +false, the ability will be active if the time is not explicitly set.

      +
    +

    Returns boolean

+
+ +
    + +
  • +

    "This function takes an ability and returns a grant."

    +

    The function is generic, which means that it can be used with any ability. The generic parameters +are the types of the ability's subject, action, and object

    + +

    Returns

    A new Grant object.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      S = string

    • +
    • +

      Act = string

    • +
    • +

      Obj = string

    +
    +

    Parameters

    +
      +
    • +
      ability: Ability<S, Act, Obj>
      +

      The ability to grant.

      +
    +

    Returns Grant<S, Act, Obj>

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/Permission.html b/docs/classes/Permission.html index 94ffa6b..e969672 100644 --- a/docs/classes/Permission.html +++ b/docs/classes/Permission.html @@ -29,7 +29,7 @@

Hierarchy

  • Permission
+
  • Defined in index.ts:106
  • @@ -61,6 +61,7 @@

    Methods

    hasScopeAny location time +build

    Constructors

    @@ -95,19 +96,19 @@
    grants:

    Returns Permission<S, Act, Obj>

    +
  • Defined in index.ts:219
  • Properties

    fields: undefined | string[]
    +
  • Defined in index.ts:108
  • filters: undefined | string[]
    +
  • Defined in index.ts:109
  • granted: boolean
    @@ -116,7 +117,7 @@

    The value of the _granted property.

    +
  • Defined in index.ts:202
  • grants: PermissionGrant<S, Act, Obj>
    @@ -125,17 +126,17 @@

    The grants property is being returned.

    +
  • Defined in index.ts:209
  • locations: undefined | string[]
    +
  • Defined in index.ts:110
  • times: undefined | Time[]
    +
  • Defined in index.ts:107
  • Methods

    @@ -149,7 +150,7 @@

    Returns

    An array of Ability objects.

    Returns Ability<S, Act, Obj>[]

    +
  • Defined in index.ts:292
    • @@ -179,7 +180,7 @@
      Optional deep_copy:

    Returns Partial<T> | Partial<T>[]

    +
  • Defined in index.ts:179
    • @@ -207,11 +208,11 @@
      Optional deep_copy:

    Returns Partial<T> | Partial<T>[]

    +
  • Defined in index.ts:192
    • - +
    • If the pattern is not provided, set it to 'any:all' (which matches everything). If the pattern is not found in the grants, throw an error. Otherwise, return the grant that matches the pattern

      @@ -225,10 +226,12 @@

      Parameters

      Optional pattern: string

      The pattern to match against. If not provided, it will match against all patterns.

      -
    -

    Returns Grant<S, Act, Obj>

    +
  • Defined in index.ts:244
    • @@ -247,7 +250,7 @@
      pattern: string

    Returns boolean

    +
  • Defined in index.ts:231
    • @@ -259,7 +262,7 @@

      Returns

      A boolean value.

      Returns boolean

    +
  • Defined in index.ts:274
    • @@ -271,7 +274,7 @@

      Returns

      A boolean value.

      Returns boolean

    +
  • Defined in index.ts:256
    • @@ -283,7 +286,7 @@

      Returns

      A boolean value.

      Returns boolean

    +
  • Defined in index.ts:283
    • @@ -295,7 +298,7 @@

      Returns

      A boolean value.

      Returns boolean

    +
  • Defined in index.ts:265
    • @@ -319,7 +322,7 @@
      Optional strict: Returns boolean
    +
  • Defined in index.ts:121
    • @@ -348,7 +351,43 @@
      Optional strict: Returns boolean
    +
  • Defined in index.ts:151
  • +
    + +
      + +
    • +

      It takes an array of abilities, and returns a permission object

      + +

      Returns

      A Permission object

      +
      +
      +

      Type Parameters

      +
        +
      • +

        S = string

      • +
      • +

        Act = string

      • +
      • +

        Obj = string

      +
      +

      Parameters

      +
        +
      • +
        granted: boolean
        +

        boolean - whether the permission is granted or not.

        +
      • +
      • +
        abilities: Ability<S, Act, Obj>[]
        +

        An array of Ability objects.

        +
      • +
      • +
        Optional sep: string = ':'
        +

        The separator used to split the action and object.

        +
      +

      Returns Permission<S, Act, Obj>

    +
  • time
  • +
  • build
  • Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/default.html b/docs/classes/default.html index 47308f7..46daa13 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -29,7 +29,7 @@

    Hierarchy

    • default
    +
  • Defined in index.ts:436
  • @@ -90,7 +90,7 @@
    abilities: Optional options: AccessControlOption

    Returns default<S, Act, Obj>

    +
  • Defined in index.ts:461
  • Properties

    @@ -102,7 +102,7 @@

    Type declaration

  • [key: string]: PermissionGrant<S, Act, Obj>
  • +
  • Defined in index.ts:441
  • _validators: {
        cron: ((val: string) => boolean);
        ip_cidr: ((val: string) => boolean);
    } = ...
    @@ -113,8 +113,8 @@

    Type declaration

    cron: ((val: string) => boolean)
    • -
        -
      • (val: string): boolean
      • +
          +
        • (val: string): boolean
        • Parameters

          @@ -126,8 +126,8 @@

          Returns booleanip_cidr: ((val: string) => boolean)

          • -
              -
            • (val: string): boolean
            • +
                +
              • (val: string): boolean
              • Parameters

                @@ -136,17 +136,17 @@

                Parameters

                val: string

          Returns boolean

    +
  • Defined in index.ts:446
  • sep: string
    +
  • Defined in index.ts:437
  • strict: boolean
    +
  • Defined in index.ts:438
  • Accessors

    @@ -165,7 +165,7 @@
    abilities:

    Returns void

    +
  • Defined in index.ts:518
  • Methods

    @@ -200,7 +200,7 @@
    Optional callable: Optional options: Omit<AccessControlOption, "sep">

    Returns Permission<S, Act, Obj>

    +
  • Defined in index.ts:536
  • +
  • Defined in index.ts:509
    • @@ -227,7 +227,7 @@
      ability:

    Returns void

    +
  • Defined in index.ts:489
    • @@ -246,7 +246,7 @@
      ability:

    Returns void

    +
  • Defined in index.ts:476
  • +
  • Defined in index.ts:68
  • +
  • Defined in index.ts:85