From 15e3678e2208c29fed1c08b858aa3d2a12582e46 Mon Sep 17 00:00:00 2001 From: ominestre Date: Tue, 31 May 2022 14:03:46 -0400 Subject: [PATCH] 2.1.0 --- CHANGELOG.md | 10 ++++++++ docs/assets/main.js | 4 ++-- docs/assets/search.js | 2 +- docs/index.html | 4 ++-- docs/interfaces/lib_config.Config.html | 2 +- .../lib_npm_interactions.OutdatedData.html | 2 +- .../lib_npm_interactions.OutdatedPackage.html | 2 +- .../lib_npm_interactions.PackageDetails.html | 2 +- docs/modules.html | 2 +- docs/modules/lib.html | 24 +++++++++---------- docs/modules/lib_config.html | 12 +++++----- docs/modules/lib_npm_interactions.html | 20 +++++++++++----- docs/pages/how-to/contribute-to-docs.html | 4 ++-- docs/pages/how-to/create-a-config-file.html | 4 ++-- docs/pages/how-to/release.html | 20 ++++++++++++++++ package.json | 2 +- 16 files changed, 77 insertions(+), 39 deletions(-) create mode 100644 docs/pages/how-to/release.html diff --git a/CHANGELOG.md b/CHANGELOG.md index c1be675..dfdd1b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## v2.1.0 + +### Added + +- Adding CLI argument `--prod` and a configuration item for only analyzing production dependencies [issue](https://github.com/ominestre/rotten-deps/issues/1) [change](https://github.com/ominestre/rotten-deps/pull/92) + +### Fixed + +- Fixed a broken link in the generated docs for the How-To guide on doing a release + ## v2.0.0 ### Breaking diff --git a/docs/assets/main.js b/docs/assets/main.js index b13205a..bd45452 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,5 +1,5 @@ -(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},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),r=1,n=0;r0){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),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=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.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)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 he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){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 r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0,a=Math.min(10,s.length);o${ve(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function me(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,u],h.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?h+=2:a==l&&(r+=n[u+1]*i[h+1],u+=2,h+=2);return r},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),r=1,n=0;r0){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 h=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=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.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)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 he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){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 r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){var o,a;if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let l=0;lu.score-l.score);for(let l=0,u=Math.min(10,s.length);l${ve(h.parent,i)}.${f}`);let p=document.createElement("li");p.classList.value=(a=h.classes)!=null?a:"";let E=document.createElement("a");E.href=n.base+h.url,E.classList.add("tsd-kind-icon"),E.innerHTML=f,p.append(E),e.appendChild(p)}}function me(t,e){var n,i;let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let s=r;if(e===1)do s=(n=s.nextElementSibling)!=null?n:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);else do s=(i=s.previousElementSibling)!=null?i:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);s&&(r.classList.remove("current"),s.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); /*! * lunr.Builder * Copyright (C) 2020 Oliver Nightingale diff --git a/docs/assets/search.js b/docs/assets/search.js index 00e3583..1139b63 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"lib/config\",\"url\":\"modules/lib_config.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":1,\"kind\":256,\"name\":\"Config\",\"url\":\"interfaces/lib_config.Config.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":2,\"kind\":1024,\"name\":\"defaultExpiration\",\"url\":\"interfaces/lib_config.Config.html#defaultExpiration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":3,\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/lib_config.Config.html#kind\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":4,\"kind\":1024,\"name\":\"rules\",\"url\":\"interfaces/lib_config.Config.html#rules\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":5,\"kind\":64,\"name\":\"createConfig\",\"url\":\"modules/lib_config.html#createConfig-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":6,\"kind\":64,\"name\":\"createFileReader\",\"url\":\"modules/lib_config.html#createFileReader-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":7,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib_config.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":8,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib/config.default\"},{\"id\":9,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib_config.html#default.__type.createFileReader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":10,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":11,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib_config.html#default.__type.createConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":12,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":13,\"kind\":2,\"name\":\"lib\",\"url\":\"modules/lib.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":14,\"kind\":4194304,\"name\":\"ReportResponse\",\"url\":\"modules/lib.html#ReportResponse\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":15,\"kind\":64,\"name\":\"generateReport\",\"url\":\"modules/lib.html#generateReport-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":16,\"kind\":32,\"name\":\"configuration\",\"url\":\"modules/lib.html#configuration\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":17,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.configuration\"},{\"id\":18,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib.html#configuration.__type.createFileReader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":19,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":20,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib.html#configuration.__type.createConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":21,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":22,\"kind\":32,\"name\":\"npm\",\"url\":\"modules/lib.html#npm-1\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":23,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.npm\"},{\"id\":24,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib.html#npm-1.__type-11.createOutdatedRequest-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":25,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11.__type-13\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":26,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib.html#npm-1.__type-11.createDetailsRequest-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":27,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11.__type-12\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":28,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":29,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.default\"},{\"id\":30,\"kind\":1024,\"name\":\"configuration\",\"url\":\"modules/lib.html#default.__type-3.configuration-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":31,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":32,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib.html#default.__type-3.__type-4.createFileReader-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":33,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":34,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib.html#default.__type-3.__type-4.createConfig-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":35,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":36,\"kind\":1024,\"name\":\"npm\",\"url\":\"modules/lib.html#default.__type-3.npm\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":37,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":38,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib.html#default.__type-3.__type-8.createOutdatedRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":39,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8.__type-10\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":40,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib.html#default.__type-3.__type-8.createDetailsRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":41,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8.__type-9\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":42,\"kind\":1024,\"name\":\"generateReport\",\"url\":\"modules/lib.html#default.__type-3.generateReport\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":43,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-7\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":44,\"kind\":2,\"name\":\"lib/npm-interactions\",\"url\":\"modules/lib_npm_interactions.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":45,\"kind\":256,\"name\":\"PackageDetails\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":46,\"kind\":1024,\"name\":\"time\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.PackageDetails\"},{\"id\":47,\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.PackageDetails\"},{\"id\":48,\"kind\":256,\"name\":\"OutdatedPackage\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":49,\"kind\":1024,\"name\":\"current\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#current\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":50,\"kind\":1024,\"name\":\"wanted\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#wanted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":51,\"kind\":1024,\"name\":\"latest\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#latest\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":52,\"kind\":1024,\"name\":\"location\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#location\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":53,\"kind\":256,\"name\":\"OutdatedData\",\"url\":\"interfaces/lib_npm_interactions.OutdatedData.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":54,\"kind\":64,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib_npm_interactions.html#createOutdatedRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":55,\"kind\":64,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib_npm_interactions.html#createDetailsRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":56,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib_npm_interactions.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":57,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default\"},{\"id\":58,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createOutdatedRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":59,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":60,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createDetailsRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":61,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":62,\"kind\":2048,\"name\":\"Page: Contribute to these docs\",\"url\":\"pages/how-to/contribute-to-docs.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true},{\"id\":63,\"kind\":2048,\"name\":\"Page: Create a config file\",\"url\":\"pages/how-to/create-a-config-file.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true},{\"id\":64,\"kind\":2048,\"name\":\"Page: Release\",\"url\":\"pages/how-to/create-a-config-file.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,26.283]],[\"parent/0\",[]],[\"name/1\",[1,34.622]],[\"parent/1\",[0,2.641]],[\"name/2\",[2,40.025]],[\"parent/2\",[3,3.122]],[\"name/3\",[4,40.025]],[\"parent/3\",[3,3.122]],[\"name/4\",[5,40.025]],[\"parent/4\",[3,3.122]],[\"name/5\",[6,28.405]],[\"parent/5\",[0,2.641]],[\"name/6\",[7,28.405]],[\"parent/6\",[0,2.641]],[\"name/7\",[8,31.063]],[\"parent/7\",[0,2.641]],[\"name/8\",[9,12.367]],[\"parent/8\",[10,4.022]],[\"name/9\",[7,28.405]],[\"parent/9\",[11,2.855]],[\"name/10\",[9,12.367]],[\"parent/10\",[11,2.855]],[\"name/11\",[6,28.405]],[\"parent/11\",[11,2.855]],[\"name/12\",[9,12.367]],[\"parent/12\",[11,2.855]],[\"name/13\",[12,24.516]],[\"parent/13\",[]],[\"name/14\",[13,40.025]],[\"parent/14\",[12,2.464]],[\"name/15\",[14,34.622]],[\"parent/15\",[12,2.464]],[\"name/16\",[15,34.622]],[\"parent/16\",[12,2.464]],[\"name/17\",[9,12.367]],[\"parent/17\",[16,4.022]],[\"name/18\",[7,28.405]],[\"parent/18\",[17,2.855]],[\"name/19\",[9,12.367]],[\"parent/19\",[17,2.855]],[\"name/20\",[6,28.405]],[\"parent/20\",[17,2.855]],[\"name/21\",[9,12.367]],[\"parent/21\",[17,2.855]],[\"name/22\",[18,34.622]],[\"parent/22\",[12,2.464]],[\"name/23\",[9,12.367]],[\"parent/23\",[19,4.022]],[\"name/24\",[20,28.405]],[\"parent/24\",[21,2.855]],[\"name/25\",[9,12.367]],[\"parent/25\",[21,2.855]],[\"name/26\",[22,28.405]],[\"parent/26\",[21,2.855]],[\"name/27\",[9,12.367]],[\"parent/27\",[21,2.855]],[\"name/28\",[8,31.063]],[\"parent/28\",[12,2.464]],[\"name/29\",[9,12.367]],[\"parent/29\",[23,4.022]],[\"name/30\",[15,34.622]],[\"parent/30\",[24,2.464]],[\"name/31\",[9,12.367]],[\"parent/31\",[24,2.464]],[\"name/32\",[7,28.405]],[\"parent/32\",[25,2.179]],[\"name/33\",[9,12.367]],[\"parent/33\",[25,2.179]],[\"name/34\",[6,28.405]],[\"parent/34\",[25,2.179]],[\"name/35\",[9,12.367]],[\"parent/35\",[25,2.179]],[\"name/36\",[18,34.622]],[\"parent/36\",[24,2.464]],[\"name/37\",[9,12.367]],[\"parent/37\",[24,2.464]],[\"name/38\",[20,28.405]],[\"parent/38\",[25,2.179]],[\"name/39\",[9,12.367]],[\"parent/39\",[25,2.179]],[\"name/40\",[22,28.405]],[\"parent/40\",[25,2.179]],[\"name/41\",[9,12.367]],[\"parent/41\",[25,2.179]],[\"name/42\",[14,34.622]],[\"parent/42\",[24,2.464]],[\"name/43\",[9,12.367]],[\"parent/43\",[24,2.464]],[\"name/44\",[26,9.784,27,16.729]],[\"parent/44\",[]],[\"name/45\",[28,40.025]],[\"parent/45\",[26,0.985,27,1.685]],[\"name/46\",[29,40.025]],[\"parent/46\",[26,0.985,30,2.536]],[\"name/47\",[31,40.025]],[\"parent/47\",[26,0.985,30,2.536]],[\"name/48\",[32,40.025]],[\"parent/48\",[26,0.985,27,1.685]],[\"name/49\",[33,40.025]],[\"parent/49\",[26,0.985,34,2.081]],[\"name/50\",[35,40.025]],[\"parent/50\",[26,0.985,34,2.081]],[\"name/51\",[36,40.025]],[\"parent/51\",[26,0.985,34,2.081]],[\"name/52\",[37,40.025]],[\"parent/52\",[26,0.985,34,2.081]],[\"name/53\",[38,40.025]],[\"parent/53\",[26,0.985,27,1.685]],[\"name/54\",[20,28.405]],[\"parent/54\",[26,0.985,27,1.685]],[\"name/55\",[22,28.405]],[\"parent/55\",[26,0.985,27,1.685]],[\"name/56\",[8,31.063]],[\"parent/56\",[26,0.985,27,1.685]],[\"name/57\",[9,12.367]],[\"parent/57\",[26,0.985,39,2.932]],[\"name/58\",[20,28.405]],[\"parent/58\",[26,0.985,40,2.081]],[\"name/59\",[9,12.367]],[\"parent/59\",[26,0.985,40,2.081]],[\"name/60\",[22,28.405]],[\"parent/60\",[26,0.985,40,2.081]],[\"name/61\",[9,12.367]],[\"parent/61\",[26,0.985,40,2.081]],[\"name/62\",[41,124.253,42,160.1,43,160.1,44,160.1,45,160.1]],[\"parent/62\",[]],[\"name/63\",[1,138.488,41,124.253,46,160.1,47,160.1,48,160.1]],[\"parent/63\",[]],[\"name/64\",[41,225.915,49,291.092]],[\"parent/64\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":9,\"name\":{\"8\":{},\"10\":{},\"12\":{},\"17\":{},\"19\":{},\"21\":{},\"23\":{},\"25\":{},\"27\":{},\"29\":{},\"31\":{},\"33\":{},\"35\":{},\"37\":{},\"39\":{},\"41\":{},\"43\":{},\"57\":{},\"59\":{},\"61\":{}},\"parent\":{}}],[\"a\",{\"_index\":47,\"name\":{\"63\":{}},\"parent\":{}}],[\"config\",{\"_index\":1,\"name\":{\"1\":{},\"63\":{}},\"parent\":{}}],[\"configuration\",{\"_index\":15,\"name\":{\"16\":{},\"30\":{}},\"parent\":{}}],[\"contribute\",{\"_index\":42,\"name\":{\"62\":{}},\"parent\":{}}],[\"create\",{\"_index\":46,\"name\":{\"63\":{}},\"parent\":{}}],[\"createconfig\",{\"_index\":6,\"name\":{\"5\":{},\"11\":{},\"20\":{},\"34\":{}},\"parent\":{}}],[\"createdetailsrequest\",{\"_index\":22,\"name\":{\"26\":{},\"40\":{},\"55\":{},\"60\":{}},\"parent\":{}}],[\"createfilereader\",{\"_index\":7,\"name\":{\"6\":{},\"9\":{},\"18\":{},\"32\":{}},\"parent\":{}}],[\"createoutdatedrequest\",{\"_index\":20,\"name\":{\"24\":{},\"38\":{},\"54\":{},\"58\":{}},\"parent\":{}}],[\"current\",{\"_index\":33,\"name\":{\"49\":{}},\"parent\":{}}],[\"default\",{\"_index\":8,\"name\":{\"7\":{},\"28\":{},\"56\":{}},\"parent\":{}}],[\"defaultexpiration\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"docs\",{\"_index\":45,\"name\":{\"62\":{}},\"parent\":{}}],[\"file\",{\"_index\":48,\"name\":{\"63\":{}},\"parent\":{}}],[\"generatereport\",{\"_index\":14,\"name\":{\"15\":{},\"42\":{}},\"parent\":{}}],[\"interactions\",{\"_index\":27,\"name\":{\"44\":{}},\"parent\":{\"45\":{},\"48\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{}}}],[\"interactions.default\",{\"_index\":39,\"name\":{},\"parent\":{\"57\":{}}}],[\"interactions.default.__type\",{\"_index\":40,\"name\":{},\"parent\":{\"58\":{},\"59\":{},\"60\":{},\"61\":{}}}],[\"interactions.outdatedpackage\",{\"_index\":34,\"name\":{},\"parent\":{\"49\":{},\"50\":{},\"51\":{},\"52\":{}}}],[\"interactions.packagedetails\",{\"_index\":30,\"name\":{},\"parent\":{\"46\":{},\"47\":{}}}],[\"kind\",{\"_index\":4,\"name\":{\"3\":{}},\"parent\":{}}],[\"latest\",{\"_index\":36,\"name\":{\"51\":{}},\"parent\":{}}],[\"lib\",{\"_index\":12,\"name\":{\"13\":{}},\"parent\":{\"14\":{},\"15\":{},\"16\":{},\"22\":{},\"28\":{}}}],[\"lib.configuration\",{\"_index\":16,\"name\":{},\"parent\":{\"17\":{}}}],[\"lib.configuration.__type\",{\"_index\":17,\"name\":{},\"parent\":{\"18\":{},\"19\":{},\"20\":{},\"21\":{}}}],[\"lib.default\",{\"_index\":23,\"name\":{},\"parent\":{\"29\":{}}}],[\"lib.default.__type\",{\"_index\":24,\"name\":{},\"parent\":{\"30\":{},\"31\":{},\"36\":{},\"37\":{},\"42\":{},\"43\":{}}}],[\"lib.default.__type.__type\",{\"_index\":25,\"name\":{},\"parent\":{\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{}}}],[\"lib.npm\",{\"_index\":19,\"name\":{},\"parent\":{\"23\":{}}}],[\"lib.npm.__type\",{\"_index\":21,\"name\":{},\"parent\":{\"24\":{},\"25\":{},\"26\":{},\"27\":{}}}],[\"lib/config\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"5\":{},\"6\":{},\"7\":{}}}],[\"lib/config.config\",{\"_index\":3,\"name\":{},\"parent\":{\"2\":{},\"3\":{},\"4\":{}}}],[\"lib/config.default\",{\"_index\":10,\"name\":{},\"parent\":{\"8\":{}}}],[\"lib/config.default.__type\",{\"_index\":11,\"name\":{},\"parent\":{\"9\":{},\"10\":{},\"11\":{},\"12\":{}}}],[\"lib/npm\",{\"_index\":26,\"name\":{\"44\":{}},\"parent\":{\"45\":{},\"46\":{},\"47\":{},\"48\":{},\"49\":{},\"50\":{},\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{}}}],[\"location\",{\"_index\":37,\"name\":{\"52\":{}},\"parent\":{}}],[\"name\",{\"_index\":31,\"name\":{\"47\":{}},\"parent\":{}}],[\"npm\",{\"_index\":18,\"name\":{\"22\":{},\"36\":{}},\"parent\":{}}],[\"outdateddata\",{\"_index\":38,\"name\":{\"53\":{}},\"parent\":{}}],[\"outdatedpackage\",{\"_index\":32,\"name\":{\"48\":{}},\"parent\":{}}],[\"packagedetails\",{\"_index\":28,\"name\":{\"45\":{}},\"parent\":{}}],[\"page\",{\"_index\":41,\"name\":{\"62\":{},\"63\":{},\"64\":{}},\"parent\":{}}],[\"release\",{\"_index\":49,\"name\":{\"64\":{}},\"parent\":{}}],[\"reportresponse\",{\"_index\":13,\"name\":{\"14\":{}},\"parent\":{}}],[\"rules\",{\"_index\":5,\"name\":{\"4\":{}},\"parent\":{}}],[\"these\",{\"_index\":44,\"name\":{\"62\":{}},\"parent\":{}}],[\"time\",{\"_index\":29,\"name\":{\"46\":{}},\"parent\":{}}],[\"to\",{\"_index\":43,\"name\":{\"62\":{}},\"parent\":{}}],[\"wanted\",{\"_index\":35,\"name\":{\"50\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"lib/config\",\"url\":\"modules/lib_config.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":1,\"kind\":256,\"name\":\"Config\",\"url\":\"interfaces/lib_config.Config.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":2,\"kind\":1024,\"name\":\"defaultExpiration\",\"url\":\"interfaces/lib_config.Config.html#defaultExpiration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":3,\"kind\":1024,\"name\":\"ignoreDevDependencies\",\"url\":\"interfaces/lib_config.Config.html#ignoreDevDependencies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":4,\"kind\":1024,\"name\":\"kind\",\"url\":\"interfaces/lib_config.Config.html#kind\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":5,\"kind\":1024,\"name\":\"rules\",\"url\":\"interfaces/lib_config.Config.html#rules\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/config.Config\"},{\"id\":6,\"kind\":64,\"name\":\"createConfig\",\"url\":\"modules/lib_config.html#createConfig-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":7,\"kind\":64,\"name\":\"createFileReader\",\"url\":\"modules/lib_config.html#createFileReader-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":8,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib_config.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/config\"},{\"id\":9,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib/config.default\"},{\"id\":10,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib_config.html#default.__type.createFileReader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":11,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":12,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib_config.html#default.__type.createConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":13,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_config.html#default.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/config.default.__type\"},{\"id\":14,\"kind\":2,\"name\":\"lib\",\"url\":\"modules/lib.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":15,\"kind\":4194304,\"name\":\"ReportResponse\",\"url\":\"modules/lib.html#ReportResponse\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":16,\"kind\":64,\"name\":\"generateReport\",\"url\":\"modules/lib.html#generateReport-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":17,\"kind\":32,\"name\":\"configuration\",\"url\":\"modules/lib.html#configuration\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":18,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.configuration\"},{\"id\":19,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib.html#configuration.__type.createFileReader\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":20,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":21,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib.html#configuration.__type.createConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":22,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#configuration.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.configuration.__type\"},{\"id\":23,\"kind\":32,\"name\":\"npm\",\"url\":\"modules/lib.html#npm-1\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":24,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.npm\"},{\"id\":25,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib.html#npm-1.__type-11.createOutdatedRequest-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":26,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11.__type-13\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":27,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib.html#npm-1.__type-11.createDetailsRequest-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":28,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#npm-1.__type-11.__type-12\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.npm.__type\"},{\"id\":29,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib\"},{\"id\":30,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib.default\"},{\"id\":31,\"kind\":1024,\"name\":\"configuration\",\"url\":\"modules/lib.html#default.__type-3.configuration-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":32,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":33,\"kind\":1024,\"name\":\"createFileReader\",\"url\":\"modules/lib.html#default.__type-3.__type-4.createFileReader-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":34,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":35,\"kind\":1024,\"name\":\"createConfig\",\"url\":\"modules/lib.html#default.__type-3.__type-4.createConfig-1\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":36,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-4.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":37,\"kind\":1024,\"name\":\"npm\",\"url\":\"modules/lib.html#default.__type-3.npm\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":38,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":39,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib.html#default.__type-3.__type-8.createOutdatedRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":40,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8.__type-10\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":41,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib.html#default.__type-3.__type-8.createDetailsRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":42,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-8.__type-9\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type.__type\"},{\"id\":43,\"kind\":1024,\"name\":\"generateReport\",\"url\":\"modules/lib.html#default.__type-3.generateReport\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":44,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib.html#default.__type-3.__type-7\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib.default.__type\"},{\"id\":45,\"kind\":2,\"name\":\"lib/npm-interactions\",\"url\":\"modules/lib_npm_interactions.html\",\"classes\":\"tsd-kind-module\",\"isPage\":false},{\"id\":46,\"kind\":256,\"name\":\"PackageDetails\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":47,\"kind\":1024,\"name\":\"time\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html#time\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.PackageDetails\"},{\"id\":48,\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/lib_npm_interactions.PackageDetails.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.PackageDetails\"},{\"id\":49,\"kind\":256,\"name\":\"OutdatedPackage\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":50,\"kind\":1024,\"name\":\"current\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#current\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":51,\"kind\":1024,\"name\":\"wanted\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#wanted\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":52,\"kind\":1024,\"name\":\"latest\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#latest\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":53,\"kind\":1024,\"name\":\"location\",\"url\":\"interfaces/lib_npm_interactions.OutdatedPackage.html#location\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"isPage\":false,\"parent\":\"lib/npm-interactions.OutdatedPackage\"},{\"id\":54,\"kind\":256,\"name\":\"OutdatedData\",\"url\":\"interfaces/lib_npm_interactions.OutdatedData.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":55,\"kind\":64,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib_npm_interactions.html#createOutdatedRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":56,\"kind\":64,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib_npm_interactions.html#createDetailsRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":57,\"kind\":64,\"name\":\"createListRequest\",\"url\":\"modules/lib_npm_interactions.html#createListRequest-1\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":58,\"kind\":32,\"name\":\"default\",\"url\":\"modules/lib_npm_interactions.html#default\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"isPage\":false,\"parent\":\"lib/npm-interactions\"},{\"id\":59,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default\"},{\"id\":60,\"kind\":1024,\"name\":\"createOutdatedRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createOutdatedRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":61,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":62,\"kind\":1024,\"name\":\"createDetailsRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createDetailsRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":63,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":64,\"kind\":1024,\"name\":\"createListRequest\",\"url\":\"modules/lib_npm_interactions.html#default.__type.createListRequest\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":65,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/lib_npm_interactions.html#default.__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"isPage\":false,\"parent\":\"lib/npm-interactions.default.__type\"},{\"id\":66,\"kind\":2048,\"name\":\"Page: Contribute to these docs\",\"url\":\"pages/how-to/contribute-to-docs.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true},{\"id\":67,\"kind\":2048,\"name\":\"Page: Create a config file\",\"url\":\"pages/how-to/create-a-config-file.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true},{\"id\":68,\"kind\":2048,\"name\":\"Page: Release\",\"url\":\"pages/how-to/release.html\",\"classes\":\"tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external pages-entry\",\"isPage\":true}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,26.827]],[\"parent/0\",[]],[\"name/1\",[1,35.142]],[\"parent/1\",[0,2.732]],[\"name/2\",[2,40.529]],[\"parent/2\",[3,2.948]],[\"name/3\",[4,40.529]],[\"parent/3\",[3,2.948]],[\"name/4\",[5,40.529]],[\"parent/4\",[3,2.948]],[\"name/5\",[6,40.529]],[\"parent/5\",[3,2.948]],[\"name/6\",[7,28.943]],[\"parent/6\",[0,2.732]],[\"name/7\",[8,28.943]],[\"parent/7\",[0,2.732]],[\"name/8\",[9,31.593]],[\"parent/8\",[0,2.732]],[\"name/9\",[10,12.449]],[\"parent/9\",[11,4.128]],[\"name/10\",[8,28.943]],[\"parent/10\",[12,2.948]],[\"name/11\",[10,12.449]],[\"parent/11\",[12,2.948]],[\"name/12\",[7,28.943]],[\"parent/12\",[12,2.948]],[\"name/13\",[10,12.449]],[\"parent/13\",[12,2.948]],[\"name/14\",[13,25.065]],[\"parent/14\",[]],[\"name/15\",[14,40.529]],[\"parent/15\",[13,2.553]],[\"name/16\",[15,35.142]],[\"parent/16\",[13,2.553]],[\"name/17\",[16,35.142]],[\"parent/17\",[13,2.553]],[\"name/18\",[10,12.449]],[\"parent/18\",[17,4.128]],[\"name/19\",[8,28.943]],[\"parent/19\",[18,2.948]],[\"name/20\",[10,12.449]],[\"parent/20\",[18,2.948]],[\"name/21\",[7,28.943]],[\"parent/21\",[18,2.948]],[\"name/22\",[10,12.449]],[\"parent/22\",[18,2.948]],[\"name/23\",[19,35.142]],[\"parent/23\",[13,2.553]],[\"name/24\",[10,12.449]],[\"parent/24\",[20,4.128]],[\"name/25\",[21,28.943]],[\"parent/25\",[22,2.948]],[\"name/26\",[10,12.449]],[\"parent/26\",[22,2.948]],[\"name/27\",[23,28.943]],[\"parent/27\",[22,2.948]],[\"name/28\",[10,12.449]],[\"parent/28\",[22,2.948]],[\"name/29\",[9,31.593]],[\"parent/29\",[13,2.553]],[\"name/30\",[10,12.449]],[\"parent/30\",[24,4.128]],[\"name/31\",[16,35.142]],[\"parent/31\",[25,2.553]],[\"name/32\",[10,12.449]],[\"parent/32\",[25,2.553]],[\"name/33\",[8,28.943]],[\"parent/33\",[26,2.265]],[\"name/34\",[10,12.449]],[\"parent/34\",[26,2.265]],[\"name/35\",[7,28.943]],[\"parent/35\",[26,2.265]],[\"name/36\",[10,12.449]],[\"parent/36\",[26,2.265]],[\"name/37\",[19,35.142]],[\"parent/37\",[25,2.553]],[\"name/38\",[10,12.449]],[\"parent/38\",[25,2.553]],[\"name/39\",[21,28.943]],[\"parent/39\",[26,2.265]],[\"name/40\",[10,12.449]],[\"parent/40\",[26,2.265]],[\"name/41\",[23,28.943]],[\"parent/41\",[26,2.265]],[\"name/42\",[10,12.449]],[\"parent/42\",[26,2.265]],[\"name/43\",[15,35.142]],[\"parent/43\",[25,2.553]],[\"name/44\",[10,12.449]],[\"parent/44\",[25,2.553]],[\"name/45\",[27,9.042,28,16.15]],[\"parent/45\",[]],[\"name/46\",[29,40.529]],[\"parent/46\",[27,0.929,28,1.659]],[\"name/47\",[30,40.529]],[\"parent/47\",[27,0.929,31,2.622]],[\"name/48\",[32,40.529]],[\"parent/48\",[27,0.929,31,2.622]],[\"name/49\",[33,40.529]],[\"parent/49\",[27,0.929,28,1.659]],[\"name/50\",[34,40.529]],[\"parent/50\",[27,0.929,35,2.159]],[\"name/51\",[36,40.529]],[\"parent/51\",[27,0.929,35,2.159]],[\"name/52\",[37,40.529]],[\"parent/52\",[27,0.929,35,2.159]],[\"name/53\",[38,40.529]],[\"parent/53\",[27,0.929,35,2.159]],[\"name/54\",[39,40.529]],[\"parent/54\",[27,0.929,28,1.659]],[\"name/55\",[21,28.943]],[\"parent/55\",[27,0.929,28,1.659]],[\"name/56\",[23,28.943]],[\"parent/56\",[27,0.929,28,1.659]],[\"name/57\",[40,35.142]],[\"parent/57\",[27,0.929,28,1.659]],[\"name/58\",[9,31.593]],[\"parent/58\",[27,0.929,28,1.659]],[\"name/59\",[10,12.449]],[\"parent/59\",[27,0.929,41,3.023]],[\"name/60\",[21,28.943]],[\"parent/60\",[27,0.929,42,1.87]],[\"name/61\",[10,12.449]],[\"parent/61\",[27,0.929,42,1.87]],[\"name/62\",[23,28.943]],[\"parent/62\",[27,0.929,42,1.87]],[\"name/63\",[10,12.449]],[\"parent/63\",[27,0.929,42,1.87]],[\"name/64\",[40,35.142]],[\"parent/64\",[27,0.929,42,1.87]],[\"name/65\",[10,12.449]],[\"parent/65\",[27,0.929,42,1.87]],[\"name/66\",[43,126.006,44,161.645,45,161.645,46,161.645,47,161.645]],[\"parent/66\",[]],[\"name/67\",[1,140.159,43,126.006,48,161.645,49,161.645,50,161.645]],[\"parent/67\",[]],[\"name/68\",[43,229.466,51,294.367]],[\"parent/68\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":10,\"name\":{\"9\":{},\"11\":{},\"13\":{},\"18\":{},\"20\":{},\"22\":{},\"24\":{},\"26\":{},\"28\":{},\"30\":{},\"32\":{},\"34\":{},\"36\":{},\"38\":{},\"40\":{},\"42\":{},\"44\":{},\"59\":{},\"61\":{},\"63\":{},\"65\":{}},\"parent\":{}}],[\"a\",{\"_index\":49,\"name\":{\"67\":{}},\"parent\":{}}],[\"config\",{\"_index\":1,\"name\":{\"1\":{},\"67\":{}},\"parent\":{}}],[\"configuration\",{\"_index\":16,\"name\":{\"17\":{},\"31\":{}},\"parent\":{}}],[\"contribute\",{\"_index\":44,\"name\":{\"66\":{}},\"parent\":{}}],[\"create\",{\"_index\":48,\"name\":{\"67\":{}},\"parent\":{}}],[\"createconfig\",{\"_index\":7,\"name\":{\"6\":{},\"12\":{},\"21\":{},\"35\":{}},\"parent\":{}}],[\"createdetailsrequest\",{\"_index\":23,\"name\":{\"27\":{},\"41\":{},\"56\":{},\"62\":{}},\"parent\":{}}],[\"createfilereader\",{\"_index\":8,\"name\":{\"7\":{},\"10\":{},\"19\":{},\"33\":{}},\"parent\":{}}],[\"createlistrequest\",{\"_index\":40,\"name\":{\"57\":{},\"64\":{}},\"parent\":{}}],[\"createoutdatedrequest\",{\"_index\":21,\"name\":{\"25\":{},\"39\":{},\"55\":{},\"60\":{}},\"parent\":{}}],[\"current\",{\"_index\":34,\"name\":{\"50\":{}},\"parent\":{}}],[\"default\",{\"_index\":9,\"name\":{\"8\":{},\"29\":{},\"58\":{}},\"parent\":{}}],[\"defaultexpiration\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"docs\",{\"_index\":47,\"name\":{\"66\":{}},\"parent\":{}}],[\"file\",{\"_index\":50,\"name\":{\"67\":{}},\"parent\":{}}],[\"generatereport\",{\"_index\":15,\"name\":{\"16\":{},\"43\":{}},\"parent\":{}}],[\"ignoredevdependencies\",{\"_index\":4,\"name\":{\"3\":{}},\"parent\":{}}],[\"interactions\",{\"_index\":28,\"name\":{\"45\":{}},\"parent\":{\"46\":{},\"49\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{}}}],[\"interactions.default\",{\"_index\":41,\"name\":{},\"parent\":{\"59\":{}}}],[\"interactions.default.__type\",{\"_index\":42,\"name\":{},\"parent\":{\"60\":{},\"61\":{},\"62\":{},\"63\":{},\"64\":{},\"65\":{}}}],[\"interactions.outdatedpackage\",{\"_index\":35,\"name\":{},\"parent\":{\"50\":{},\"51\":{},\"52\":{},\"53\":{}}}],[\"interactions.packagedetails\",{\"_index\":31,\"name\":{},\"parent\":{\"47\":{},\"48\":{}}}],[\"kind\",{\"_index\":5,\"name\":{\"4\":{}},\"parent\":{}}],[\"latest\",{\"_index\":37,\"name\":{\"52\":{}},\"parent\":{}}],[\"lib\",{\"_index\":13,\"name\":{\"14\":{}},\"parent\":{\"15\":{},\"16\":{},\"17\":{},\"23\":{},\"29\":{}}}],[\"lib.configuration\",{\"_index\":17,\"name\":{},\"parent\":{\"18\":{}}}],[\"lib.configuration.__type\",{\"_index\":18,\"name\":{},\"parent\":{\"19\":{},\"20\":{},\"21\":{},\"22\":{}}}],[\"lib.default\",{\"_index\":24,\"name\":{},\"parent\":{\"30\":{}}}],[\"lib.default.__type\",{\"_index\":25,\"name\":{},\"parent\":{\"31\":{},\"32\":{},\"37\":{},\"38\":{},\"43\":{},\"44\":{}}}],[\"lib.default.__type.__type\",{\"_index\":26,\"name\":{},\"parent\":{\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"39\":{},\"40\":{},\"41\":{},\"42\":{}}}],[\"lib.npm\",{\"_index\":20,\"name\":{},\"parent\":{\"24\":{}}}],[\"lib.npm.__type\",{\"_index\":22,\"name\":{},\"parent\":{\"25\":{},\"26\":{},\"27\":{},\"28\":{}}}],[\"lib/config\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"6\":{},\"7\":{},\"8\":{}}}],[\"lib/config.config\",{\"_index\":3,\"name\":{},\"parent\":{\"2\":{},\"3\":{},\"4\":{},\"5\":{}}}],[\"lib/config.default\",{\"_index\":11,\"name\":{},\"parent\":{\"9\":{}}}],[\"lib/config.default.__type\",{\"_index\":12,\"name\":{},\"parent\":{\"10\":{},\"11\":{},\"12\":{},\"13\":{}}}],[\"lib/npm\",{\"_index\":27,\"name\":{\"45\":{}},\"parent\":{\"46\":{},\"47\":{},\"48\":{},\"49\":{},\"50\":{},\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{},\"56\":{},\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{},\"62\":{},\"63\":{},\"64\":{},\"65\":{}}}],[\"location\",{\"_index\":38,\"name\":{\"53\":{}},\"parent\":{}}],[\"name\",{\"_index\":32,\"name\":{\"48\":{}},\"parent\":{}}],[\"npm\",{\"_index\":19,\"name\":{\"23\":{},\"37\":{}},\"parent\":{}}],[\"outdateddata\",{\"_index\":39,\"name\":{\"54\":{}},\"parent\":{}}],[\"outdatedpackage\",{\"_index\":33,\"name\":{\"49\":{}},\"parent\":{}}],[\"packagedetails\",{\"_index\":29,\"name\":{\"46\":{}},\"parent\":{}}],[\"page\",{\"_index\":43,\"name\":{\"66\":{},\"67\":{},\"68\":{}},\"parent\":{}}],[\"release\",{\"_index\":51,\"name\":{\"68\":{}},\"parent\":{}}],[\"reportresponse\",{\"_index\":14,\"name\":{\"15\":{}},\"parent\":{}}],[\"rules\",{\"_index\":6,\"name\":{\"5\":{}},\"parent\":{}}],[\"these\",{\"_index\":46,\"name\":{\"66\":{}},\"parent\":{}}],[\"time\",{\"_index\":30,\"name\":{\"47\":{}},\"parent\":{}}],[\"to\",{\"_index\":45,\"name\":{\"66\":{}},\"parent\":{}}],[\"wanted\",{\"_index\":36,\"name\":{\"51\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index f45e918..742b457 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

rotten-deps - v2.0.0

+rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

rotten-deps - v2.1.0

Rotten Deps

 @@ -90,4 +90,4 @@

Exit codes and meanings

Contributing

For instructions on contributing to this project please see CONTRIBUTING.md.

-

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_config.Config.html b/docs/interfaces/lib_config.Config.html index 700965a..b9d3d8f 100644 --- a/docs/interfaces/lib_config.Config.html +++ b/docs/interfaces/lib_config.Config.html @@ -1 +1 @@ -Config | rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Config

Hierarchy

  • Config

Index

Properties

Properties

Optional defaultExpiration

defaultExpiration?: number

Optional Readonly kind

kind?: "config"

Readonly rules

rules: Rule[]

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +Config | rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Config

Hierarchy

  • Config

Index

Properties

Properties

Optional defaultExpiration

defaultExpiration?: number

Optional ignoreDevDependencies

ignoreDevDependencies?: boolean

Optional Readonly kind

kind?: "config"

Readonly rules

rules: Rule[]

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_npm_interactions.OutdatedData.html b/docs/interfaces/lib_npm_interactions.OutdatedData.html index efde07f..4944dd4 100644 --- a/docs/interfaces/lib_npm_interactions.OutdatedData.html +++ b/docs/interfaces/lib_npm_interactions.OutdatedData.html @@ -1 +1 @@ -OutdatedData | rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OutdatedData

Hierarchy

  • OutdatedData

Indexable

[key: string]: OutdatedPackage

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +OutdatedData | rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OutdatedData

Hierarchy

  • OutdatedData

Indexable

[key: string]: OutdatedPackage

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_npm_interactions.OutdatedPackage.html b/docs/interfaces/lib_npm_interactions.OutdatedPackage.html index e63eaba..8b44640 100644 --- a/docs/interfaces/lib_npm_interactions.OutdatedPackage.html +++ b/docs/interfaces/lib_npm_interactions.OutdatedPackage.html @@ -1 +1 @@ -OutdatedPackage | rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OutdatedPackage

Hierarchy

  • OutdatedPackage

Index

Properties

Properties

current

current: string

latest

latest: string

location

location: string

wanted

wanted: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +OutdatedPackage | rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OutdatedPackage

Hierarchy

  • OutdatedPackage

Index

Properties

Properties

current

current: string

latest

latest: string

location

location: string

wanted

wanted: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/lib_npm_interactions.PackageDetails.html b/docs/interfaces/lib_npm_interactions.PackageDetails.html index b4395aa..3d8a31f 100644 --- a/docs/interfaces/lib_npm_interactions.PackageDetails.html +++ b/docs/interfaces/lib_npm_interactions.PackageDetails.html @@ -1 +1 @@ -PackageDetails | rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PackageDetails

Hierarchy

  • PackageDetails

Index

Properties

Properties

name

name: string

time

time: Record<string, string>

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +PackageDetails | rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PackageDetails

Hierarchy

  • PackageDetails

Index

Properties

Properties

name

name: string

time

time: Record<string, string>

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 7f533c9..6cdf6e2 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

rotten-deps - v2.0.0

Index

Modules

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

rotten-deps - v2.1.0

Index

Modules

Legend

  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/lib.html b/docs/modules/lib.html index 20d5d11..d742a64 100644 --- a/docs/modules/lib.html +++ b/docs/modules/lib.html @@ -1,43 +1,43 @@ -lib | rotten-deps - v2.0.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module lib

+lib | rotten-deps - v2.1.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module lib

Rotten Deps API

-

Index

Type aliases

Variables

Functions

Type aliases

ReportResponse

ReportResponse: Report | ReportWithWarning

Variables

Const configuration

configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader } = ...

Type declaration

Index

Type Aliases

Variables

Functions

Type Aliases

ReportResponse

ReportResponse: Report | ReportWithWarning

Variables

Const configuration

configuration: { createConfig: ((config: Config) => Config); createFileReader: ((absoluteFilePath: string) => FileReader) } = ...

Type declaration

  • createConfig: ((config: Config) => Config)

      • Validates a raw configuration file and generates a report if any rules are misconfigured.

        Parameters

        • config: Config

          rotten deps configuration object

          -

        Returns Config

  • createFileReader: (absoluteFilePath: string) => FileReader
      • (absoluteFilePath: string): FileReader
      • +

      Returns Config

  • createFileReader: ((absoluteFilePath: string) => FileReader)
      • (absoluteFilePath: string): FileReader

      • Creates a filereader function for fetching the contents of a config file at the provided path.

        Parameters

        • absoluteFilePath: string

          absolute path to the configuration file

          -

        Returns FileReader

    • default

    default: { configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }; generateReport: (c: Config, r?: Reporter) => Promise<ReportResponse | Error>; npm: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest } }

    Type declaration

    • configuration: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }

    default

    default: { configuration: { createConfig: ((config: Config) => Config); createFileReader: ((absoluteFilePath: string) => FileReader) }; generateReport: ((c: Config, r?: Reporter) => Promise<Error | ReportResponse>); npm: { createDetailsRequest: ((dependencyName: string) => DetailsRequest); createOutdatedRequest: (() => OutdatedRequest) } }

    Type declaration

    • configuration: { createConfig: ((config: Config) => Config); createFileReader: ((absoluteFilePath: string) => FileReader) }
      • createConfig: ((config: Config) => Config)

          • Validates a raw configuration file and generates a report if any rules are misconfigured.

            Parameters

            • config: Config

              rotten deps configuration object

              -

            Returns Config

      • createFileReader: (absoluteFilePath: string) => FileReader
          • (absoluteFilePath: string): FileReader
          • +

          Returns Config

    • createFileReader: ((absoluteFilePath: string) => FileReader)
        • (absoluteFilePath: string): FileReader

        • Creates a filereader function for fetching the contents of a config file at the provided path.

          Parameters

          • absoluteFilePath: string

            absolute path to the configuration file

            -

          Returns FileReader

  • generateReport: (c: Config, r?: Reporter) => Promise<ReportResponse | Error>
  • generateReport: ((c: Config, r?: Reporter) => Promise<Error | ReportResponse>)

      • Compares the details on each dependency flagged as outdated in order to determine how stale a version actually is.

        Parameters

        • c: Config
        • Optional r: Reporter

          Optional reporter object with functions for hooking middleware into the report generation process

          -

        Returns Promise<ReportResponse | Error>

  • npm: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest }
    • createDetailsRequest: (dependencyName: string) => DetailsRequest
        • (dependencyName: string): DetailsRequest
        • +

        Returns Promise<Error | ReportResponse>

  • npm: { createDetailsRequest: ((dependencyName: string) => DetailsRequest); createOutdatedRequest: (() => OutdatedRequest) }
    • createDetailsRequest: ((dependencyName: string) => DetailsRequest)
        • (dependencyName: string): DetailsRequest

        • Creates a function to run the npm view command for a specific dependency

          Parameters

          • dependencyName: string
            -

          Returns DetailsRequest

    • createOutdatedRequest: () => OutdatedRequest
        • (): OutdatedRequest
        • +

        Returns DetailsRequest

  • createOutdatedRequest: (() => OutdatedRequest)
      • (): OutdatedRequest

      • Creates a function for running npm outdated

        -

        Returns OutdatedRequest

    • Const npm

    npm: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest } = ...

    Type declaration

    • createDetailsRequest: (dependencyName: string) => DetailsRequest
        • (dependencyName: string): DetailsRequest
        • +

          Returns OutdatedRequest

    Const npm

    npm: { createDetailsRequest: ((dependencyName: string) => DetailsRequest); createOutdatedRequest: (() => OutdatedRequest) } = ...

    Type declaration

    • createDetailsRequest: ((dependencyName: string) => DetailsRequest)
        • (dependencyName: string): DetailsRequest

        • Creates a function to run the npm view command for a specific dependency

          Parameters

          • dependencyName: string
            -

          Returns DetailsRequest

    • createOutdatedRequest: () => OutdatedRequest
        • (): OutdatedRequest
        • +

        Returns DetailsRequest

  • createOutdatedRequest: (() => OutdatedRequest)
      • (): OutdatedRequest

      • Creates a function for running npm outdated

        -

        Returns OutdatedRequest

    • Functions

    generateReport

    Functions

    generateReport

    • Compares the details on each dependency flagged as outdated in order to determine how stale a version actually is.

      Parameters

      • c: Config
      • Optional r: Reporter

        Optional reporter object with functions for hooking middleware into the report generation process

        -

      Returns Promise<ReportResponse | Error>

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<Error | ReportResponse>

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib_config.html b/docs/modules/lib_config.html index 0f36c2e..e33b634 100644 --- a/docs/modules/lib_config.html +++ b/docs/modules/lib_config.html @@ -1,23 +1,23 @@ -lib/config | rotten-deps - v2.0.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module lib/config

    +lib/config | rotten-deps - v2.1.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module lib/config

    Rotten Deps configuration library

    -

    Index

    Interfaces

    Variables

    Functions

    Variables

    default

    default: { createConfig: (config: Config) => Config; createFileReader: (absoluteFilePath: string) => FileReader }

    Type declaration

    Index

    Interfaces

    Variables

    Functions

    Variables

    default

    default: { createConfig: ((config: Config) => Config); createFileReader: ((absoluteFilePath: string) => FileReader) }

    Type declaration

    • createConfig: ((config: Config) => Config)

        • Validates a raw configuration file and generates a report if any rules are misconfigured.

          Parameters

          • config: Config

            rotten deps configuration object

            -

          Returns Config

    • createFileReader: (absoluteFilePath: string) => FileReader
        • (absoluteFilePath: string): FileReader
        • +

        Returns Config

  • createFileReader: ((absoluteFilePath: string) => FileReader)
      • (absoluteFilePath: string): FileReader

      • Creates a filereader function for fetching the contents of a config file at the provided path.

        Parameters

        • absoluteFilePath: string

          absolute path to the configuration file

          -

        Returns FileReader

    • Functions

    createConfig

    Returns FileReader

    Functions

    createConfig

    • Validates a raw configuration file and generates a report if any rules are misconfigured.

      Parameters

      • config: Config

        rotten deps configuration object

        -

      Returns Config

    createFileReader

    • createFileReader(absoluteFilePath: string): FileReader

    Returns Config

    createFileReader

    • createFileReader(absoluteFilePath: string): FileReader

    • Creates a filereader function for fetching the contents of a config file at the provided path.

      Parameters

      • absoluteFilePath: string

        absolute path to the configuration file

        -

      Returns FileReader

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns FileReader

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib_npm_interactions.html b/docs/modules/lib_npm_interactions.html index 9045eda..d0cc7b9 100644 --- a/docs/modules/lib_npm_interactions.html +++ b/docs/modules/lib_npm_interactions.html @@ -1,13 +1,21 @@ -lib/npm-interactions | rotten-deps - v2.0.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module lib/npm-interactions

    +lib/npm-interactions | rotten-deps - v2.1.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module lib/npm-interactions

    Rotten Deps NPM Interactions library

    -

    Index

    Interfaces

    Variables

    Functions

    Variables

    default

    default: { createDetailsRequest: (dependencyName: string) => DetailsRequest; createOutdatedRequest: () => OutdatedRequest }

    Type declaration

    • createDetailsRequest: (dependencyName: string) => DetailsRequest
        • (dependencyName: string): DetailsRequest
        • +

    Index

    Interfaces

    Variables

    Functions

    Variables

    default

    default: { createDetailsRequest: ((dependencyName: string) => DetailsRequest); createListRequest: ((prod?: boolean) => ListRequest); createOutdatedRequest: (() => OutdatedRequest) }

    Type declaration

    • createDetailsRequest: ((dependencyName: string) => DetailsRequest)
        • (dependencyName: string): DetailsRequest

        • Creates a function to run the npm view command for a specific dependency

          Parameters

          • dependencyName: string
            -

          Returns DetailsRequest

    • createOutdatedRequest: () => OutdatedRequest
        • (): OutdatedRequest
        • +

        Returns DetailsRequest

  • createListRequest: ((prod?: boolean) => ListRequest)
      • (prod?: boolean): ListRequest
      • +

        Uses the npm ls command to get a list of installed dependencies of a project.

        +

        Parameters

        • prod: boolean = false
          +

          if this is set to true dev dependencies will be ignored

          +

        Returns ListRequest

  • createOutdatedRequest: (() => OutdatedRequest)
      • (): OutdatedRequest

      • Creates a function for running npm outdated

        -

        Returns OutdatedRequest

    • Functions

    createDetailsRequest

    • createDetailsRequest(dependencyName: string): DetailsRequest

    Functions

    createDetailsRequest

    • createDetailsRequest(dependencyName: string): DetailsRequest

    • Creates a function to run the npm view command for a specific dependency

      Parameters

      • dependencyName: string
        -

      Returns DetailsRequest

    createOutdatedRequest

    • createOutdatedRequest(): OutdatedRequest

    Returns DetailsRequest

    createListRequest

    • createListRequest(prod?: boolean): ListRequest
    • +

      Uses the npm ls command to get a list of installed dependencies of a project.

      +

      Parameters

      • prod: boolean = false
        +

        if this is set to true dev dependencies will be ignored

        +

      Returns ListRequest

    createOutdatedRequest

    • createOutdatedRequest(): OutdatedRequest

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns OutdatedRequest

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/pages/how-to/contribute-to-docs.html b/docs/pages/how-to/contribute-to-docs.html index ed64eb8..f6f08ef 100644 --- a/docs/pages/how-to/contribute-to-docs.html +++ b/docs/pages/how-to/contribute-to-docs.html @@ -1,4 +1,4 @@ -Contribute to these docs | rotten-deps - v2.0.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Contribute to these docs

    +Contribute to these docs | rotten-deps - v2.1.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Contribute to these docs

    How to contribute to the documentation

     @@ -39,4 +39,4 @@

    Updating API/Reference documentation

    /**
     * Creates a file-reader function for fetching the contents of a config 
     * file at the provided path.
     * @param absoluteFilePath absolute path to the configuration file
     */

    When the tsdoc generator runs it will pull this comment into the reference docs for that particular module. In this example we have a function description and a parameter description. The param types and returns are generated from the function definition.

    -

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/pages/how-to/create-a-config-file.html b/docs/pages/how-to/create-a-config-file.html index 1f28822..59adffd 100644 --- a/docs/pages/how-to/create-a-config-file.html +++ b/docs/pages/how-to/create-a-config-file.html @@ -1,4 +1,4 @@ -Release | rotten-deps - v2.0.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Release

    +Create a config file | rotten-deps - v2.1.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Create a config file

    How to create and use a configuration file

     @@ -34,4 +34,4 @@

    rules: Array<Rule>

  • OPTIONAL daysUntilExpiration: number This sets the expiration period for the individual dependency
  • OPTIONAL reason: string This sets the reason for the specific rule which will be output into the table. Useful for memorizing why you whitelisted something to make it more likely that you follow up and fix later.
    • -

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/pages/how-to/release.html b/docs/pages/how-to/release.html new file mode 100644 index 0000000..ce7c0a8 --- /dev/null +++ b/docs/pages/how-to/release.html @@ -0,0 +1,20 @@ +Release | rotten-deps - v2.1.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Release

    + +

    How to release a new version of Rotten Deps

    +     +
      +
    1. Create a new changelog entry using semver in the title. The release version in the follow steps is pulled from the changelog version header
      2. +
    2. Run the command yarn run docs to generate the new documentation for the GitHub page
      3. +
    3. Run the release script using bash scripts/release.sh
        +
      • Since the documentation reads the version of the package.json this first creates a dummy NPM version without creating a commit or tag
        • +
      • Once the dummy version is created the docs are generated
        • +
      • The docs and CHANGELOG.md are staged in git
        • +
      • The real npm version is run creating a release commit and tag
        • +
      +
      4. +
    4. Push the release using git push origin main
      5. +
    5. Push the new tag using git push --tags
      6. +
    6. Login to NPM using npm login
      7. +
    7. Publish to NPM using npm publish --access public
      8. +
    +

    Legend

    • Variable
    • Function
    • Type alias
    • Interface

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/package.json b/package.json index 65eb4a8..125e400 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rotten-deps", - "version": "2.0.0", + "version": "2.1.0", "description": "The command `npm outdated` only has two endpoints which are pass or fail. This dichotomy isn't very useful for CI flows which have pass, fail, or warn. This CLI utility combines `npm outdated` and `npm view` in order to establish a compliance period for dependency checks. This way if a dependency update is within your compliance period you can trigger a warn or if it's beyond your compliance period it can trigger a fail.", "engines": { "node": ">=14"