@superawesome/permissions-nestjs
Version:
NestJS Guard & Decorators for @superawesome/permissions, promoting orthogonal fine-grained API access control to resources.
197 lines (164 loc) • 7.58 kB
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 miscellaneous-typealiases">
<div class="content-data">
<ol class="breadcrumb">
<li>Miscellaneous</li>
<li>Type aliases</li>
</ol>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#PermitGrantArgs" title="src/PermitGrant.decorator.ts"><b>PermitGrantArgs</b> (src/.../PermitGrant.decorator.ts)</a>
</li>
<li>
<a href="#TExtractUserFromRequest" title="src/types.ts"><b>TExtractUserFromRequest</b> (src/.../types.ts)</a>
</li>
<li>
<a href="#TProjectTo" title="src/types.ts"><b>TProjectTo</b> (src/.../types.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/PermitGrant.decorator.ts</h3>
<section>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="PermitGrantArgs"></a>
<span class="name"><b>PermitGrantArgs</b><a href="#PermitGrantArgs"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code><a href="../classes/PermitGrantQuery.html" target="_self" >PermitGrantQuery | "undefined"</a></code>
</code>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/types.ts</h3>
<section>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TExtractUserFromRequest"></a>
<span class="name"><b>TExtractUserFromRequest</b><a href="#TExtractUserFromRequest"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>The <code>extractUserFromRequest</code> callback extracts and returns an <code>IUser {id: TId; roles: string[]}</code>.</p>
<p>Usually our User is in <code>req.user</code> object or similar, placed by our authentication middleware.
Alternatively you can use something like request-context or its newer cls-hooked incarnations etc.</p>
<p>If <code>req.user</code> complies already, you can omit this callback as <code>defaultExtractUserFromRequest</code> does it for you.</p>
<p>You can use also to inject test or hardcode environment users etc.</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="TProjectTo"></a>
<span class="name"><b>TProjectTo</b><a href="#TProjectTo"><span class="icon ion-ios-link"></span></a></span>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Project from one value to another, used to project req to our ResourceId (projectResourceId)</p>
</div>
</td>
</tr>
<tr>
<td class="col-md-4">
<code> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
</code>
</td>
</tr>
</tbody>
</table>
</section>
</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 = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-typealiases';
var COMPODOC_CURRENT_PAGE_URL = 'typealiases.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>