UNPKG

@superawesome/permissions-nestjs

Version:

NestJS Guard & Decorators for @superawesome/permissions, promoting orthogonal fine-grained API access control to resources.

234 lines (200 loc) 8.35 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>SuperAwesome Permissions for NestJs (@superawesome/permissions-nestjs)</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" type="image/x-icon" href="./images/favicon.ico"> <link rel="stylesheet" href="./styles/style.css"> <link rel="stylesheet" href="./styles/postmark.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="./" class="navbar-brand">SuperAwesome Permissions for NestJs (@superawesome/permissions-nestjs)</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </div> <div class="xs-menu menu" id="mobile-menu"> <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu> </div> <div class="container-fluid main"> <div class="row main"> <div class="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content coverage"> <div class="content-data"> <ol class="breadcrumb"> <li>Documentation coverage</li> </ol> <div> <img src="./images/coverage-badge-documentation.svg"> </div> <table class="table table-bordered coverage" id="coverage-table"> <thead class="coverage-header"> <tr> <th>File</th> <th>Type</th> <th>Identifier</th> <th style="text-align:right" class="statements" data-sort-default>Statements</th> </tr> </thead> <tbody> <tr class="low"> <td> <!-- miscellaneous --> <a href="./miscellaneous/variables.html#GetPermit">src/GetPermit.decorator.ts</a> </td> <td>variable</td> <td>GetPermit</td> <td align="right" data-sort="0"> <span class="coverage-percent">0 %</span> <span class="coverage-count">(0/1)</span> </td> </tr> <tr class="low"> <td> <!-- miscellaneous --> <a href="./classes/PermitGrantQuery.html">src/PermitGrant.decorator.ts</a> </td> <td>class</td> <td>PermitGrantQuery</td> <td align="right" data-sort="16"> <span class="coverage-percent">16 %</span> <span class="coverage-count">(1/6)</span> </td> </tr> <tr class="very-good"> <td> <!-- miscellaneous --> <a href="./miscellaneous/variables.html#PermitGrant">src/PermitGrant.decorator.ts</a> </td> <td>variable</td> <td>PermitGrant</td> <td align="right" data-sort="100"> <span class="coverage-percent">100 %</span> <span class="coverage-count">(1/1)</span> </td> </tr> <tr class="low"> <td> <!-- miscellaneous --> <a href="./interfaces/IGuardOptions.html">src/createPermissionsGuard.ts</a> </td> <td>interface</td> <td>IGuardOptions</td> <td align="right" data-sort="0"> <span class="coverage-percent">0 %</span> <span class="coverage-count">(0/3)</span> </td> </tr> <tr class="very-good"> <td> <!-- miscellaneous --> <a href="./miscellaneous/variables.html#createPermissionsGuard">src/createPermissionsGuard.ts</a> </td> <td>variable</td> <td>createPermissionsGuard</td> <td align="right" data-sort="100"> <span class="coverage-percent">100 %</span> <span class="coverage-count">(1/1)</span> </td> </tr> <tr class="very-good"> <td> <!-- miscellaneous --> <a href="./miscellaneous/variables.html#InjectPermissions">src/inject-permissions.decorator.ts</a> </td> <td>variable</td> <td>InjectPermissions</td> <td align="right" data-sort="100"> <span class="coverage-percent">100 %</span> <span class="coverage-count">(1/1)</span> </td> </tr> <tr class="low"> <td> <!-- miscellaneous --> <a href="./interfaces/IPermissionDefinitionStringOwnHooks.html">src/types.ts</a> </td> <td>interface</td> <td>IPermissionDefinitionStringOwnHooks</td> <td align="right" data-sort="25"> <span class="coverage-percent">25 %</span> <span class="coverage-count">(1/4)</span> </td> </tr> <tr class="low"> <td> <!-- miscellaneous --> <a href="./interfaces/IPermissionsModuleOptions.html">src/types.ts</a> </td> <td>interface</td> <td>IPermissionsModuleOptions</td> <td align="right" data-sort="0"> <span class="coverage-percent">0 %</span> <span class="coverage-count">(0/3)</span> </td> </tr> <tr class="low"> <td> <!-- miscellaneous --> <a href="./miscellaneous/variables.html#PERMISSIONS_OWNERSHIP_SERVICE_TOKEN">src/types.ts</a> </td> <td>variable</td> <td>PERMISSIONS_OWNERSHIP_SERVICE_TOKEN</td> <td align="right" data-sort="0"> <span class="coverage-percent">0 %</span> <span class="coverage-count">(0/1)</span> </td> </tr> </tbody> </table> <script src="js/libs/tablesort.min.js"></script> <script src="js/libs/tablesort.number.min.js"></script> <script> new Tablesort(document.getElementById('coverage-table')); </script> </div><div class="search-results"> <div class="has-results"> <h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> </div> </div> </div> <!-- END CONTENT --> </div> </div> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 0; var COMPODOC_CURRENT_PAGE_CONTEXT = 'coverage'; var COMPODOC_CURRENT_PAGE_URL = 'coverage.html'; </script> <script src="./js/libs/custom-elements.min.js"></script> <script src="./js/libs/lit-html.js"></script> <!-- Required to polyfill modern browsers as code is ES5 for IE... --> <script src="./js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script> <script src="./js/menu-wc.js" defer></script> <script src="./js/libs/bootstrap-native.js"></script> <script src="./js/libs/es6-shim.min.js"></script> <script src="./js/libs/EventDispatcher.js"></script> <script src="./js/libs/promise.min.js"></script> <script src="./js/libs/zepto.min.js"></script> <script src="./js/compodoc.js"></script> <script src="./js/tabs.js"></script> <script src="./js/menu.js"></script> <script src="./js/libs/clipboard.min.js"></script> <script src="./js/libs/prism.js"></script> <script src="./js/sourceCode.js"></script> <script src="./js/search/search.js"></script> <script src="./js/search/lunr.min.js"></script> <script src="./js/search/search-lunr.js"></script> <script src="./js/search/search_index.js"></script> <script src="./js/lazy-load-graphs.js"></script> </body> </html>