Module
x/permissionGuard/docs/interfaces/_guard_.permissiondescriptorlike.html
A zero-dependency, minimal permission guard for Deno.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313<!doctype html><html class="default no-js"><head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>PermissionDescriptorLike | permission-guard</title> <meta name="description" content="Documentation for permission-guard"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"></head><body><header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">permission-guard</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_guard_.html">"guard"</a> </li> <li> <a href="_guard_.permissiondescriptorlike.html">PermissionDescriptorLike</a> </li> </ul> <h1>Interface PermissionDescriptorLike</h1> </div> </div></header><div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">PermissionDescriptorLike</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-not-exported"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#command" class="tsd-kind-icon">command</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#host" class="tsd-kind-icon">host</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#name" class="tsd-kind-icon">name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#path" class="tsd-kind-icon">path</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#state" class="tsd-kind-icon">state</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#url" class="tsd-kind-icon">url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"><a href="_guard_.permissiondescriptorlike.html#variable" class="tsd-kind-icon">variable</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-not-exported"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="command" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3> <div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L301">guard.ts:301</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="host" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> host</h3> <div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L299">guard.ts:299</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="name" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3> <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L296">guard.ts:296</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="path" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> path</h3> <div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L300">guard.ts:300</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="state" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> state</h3> <div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Deno.PermissionState</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L297">guard.ts:297</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="url" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3> <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L298">guard.ts:298</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a name="variable" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> variable</h3> <div class="tsd-signature tsd-kind-icon">variable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/asos-craigmorten/permission-guard/blob/54ee4b7/src/guard.ts#L302">guard.ts:302</a></li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class="current tsd-kind-module"> <a href="../modules/_guard_.html">"guard"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_guard_.guardoptions.html" class="tsd-kind-icon">Guard<wbr>Options</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html" class="tsd-kind-icon">Permission<wbr>Descriptor<wbr>Like</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#command" class="tsd-kind-icon">command</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#host" class="tsd-kind-icon">host</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#name" class="tsd-kind-icon">name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#path" class="tsd-kind-icon">path</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#state" class="tsd-kind-icon">state</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#url" class="tsd-kind-icon">url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-not-exported"> <a href="_guard_.permissiondescriptorlike.html#variable" class="tsd-kind-icon">variable</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/_guard_.html#guardgrant" class="tsd-kind-icon">Guard<wbr>Grant</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#permissiondescriptorstatus" class="tsd-kind-icon">Permission<wbr>Descriptor<wbr>Status</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#denied" class="tsd-kind-icon">DENIED</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#env" class="tsd-kind-icon">ENV</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#granted" class="tsd-kind-icon">GRANTED</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#hrtime" class="tsd-kind-icon">HRTIME</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#http_protocol" class="tsd-kind-icon">HTTP_<wbr>PROTOCOL</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#net" class="tsd-kind-icon">NET</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#plugin" class="tsd-kind-icon">PLUGIN</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#prompt" class="tsd-kind-icon">PROMPT</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#read" class="tsd-kind-icon">READ</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#run" class="tsd-kind-icon">RUN</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module"> <a href="../modules/_guard_.html#write" class="tsd-kind-icon">WRITE</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#permissionnametoflagmap" class="tsd-kind-icon">permission<wbr>Name<wbr>ToFlag<wbr>Map</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#permissionswithallowlists" class="tsd-kind-icon">permissions<wbr>With<wbr>Allowlists</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#toplevelpermissions" class="tsd-kind-icon">top<wbr>Level<wbr>Permissions</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#getpermissionallowlist" class="tsd-kind-icon">get<wbr>Permission<wbr>Allowlist</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#getpermissiondescriptorstatus" class="tsd-kind-icon">get<wbr>Permission<wbr>Descriptor<wbr>Status</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#getunscopedpermissions" class="tsd-kind-icon">get<wbr>Unscoped<wbr>Permissions</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/_guard_.html#guard" class="tsd-kind-icon">guard</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#handlemissinggrantedpermissions" class="tsd-kind-icon">handle<wbr>Missing<wbr>Granted<wbr>Permissions</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#handleungrantedtoplevelpermissions" class="tsd-kind-icon">handle<wbr>Ungranted<wbr>Top<wbr>Level<wbr>Permissions</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported"> <a href="../modules/_guard_.html#handleunscopedpermissions" class="tsd-kind-icon">handle<wbr>Unscoped<wbr>Permissions</a> </li> </ul> </nav> </div> </div></div><footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> </div> </div></footer><div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/js/main.js"></script></body></html>