@superawesome/permissions
Version:
Fine grained permissions / access control with ownerships & attribute picking, done right.
224 lines (184 loc) • 8.27 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>SuperAwesome Permissions (@superawesome/permissions)</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 (@superawesome/permissions)</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-variables">
<div class="content-data">
<ol class="breadcrumb">
<li>Miscellaneous</li>
<li>Variables</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="#getLogger" title="src/logger.ts"><b>getLogger</b> (src/.../logger.ts)</a>
</li>
<li>
<a href="#isValidIUser" title="src/types.ts"><b>isValidIUser</b> (src/.../types.ts)</a>
</li>
<li>
<a href="#setLogger" title="src/logger.ts"><b>setLogger</b> (src/.../logger.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/logger.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getLogger"></a>
<span class="name">
<b>
getLogger</b>
<a href="#getLogger"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>(): IPermissionsLogger => logger || nullLogger</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Gives you the global logger so you can log eg <code>getLogger().warn('Something fishy!')</code></p>
<p>See <a href="/interfaces/IPermissionsLogger.html">IPermissionsLogger</a></p>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="setLogger"></a>
<span class="name">
<b>
setLogger</b>
<a href="#setLogger"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code><T extends IPermissionsLogger>(l: T | null): IPermissionsLogger =>
(logger = l)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Set a <strong>global</strong> logger (<a href="/interfaces/IPermissionsLogger.html">IPermissionsLogger</a>) used by the library, instead of the console built in one.</p>
<p>Use <code>setLogger(null)</code> to disable it.</p>
<p>See <a href="/interfaces/IPermissionsLogger.html">IPermissionsLogger</a></p>
</div>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/types.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="isValidIUser"></a>
<span class="name">
<b>
isValidIUser</b>
<a href="#isValidIUser"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code><TUserId extends Tid>(user: IUser<TUserId>) =>
!!user &&
['number', 'string'].includes(typeof user.id) &&
Array.isArray(user?.roles) &&
user.roles.every((role) => typeof role === 'string')</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Checks if the user value is a correct <a href="/interfaces/IUser.html"><code>IUser</code> type</a></p>
</div>
</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-variables';
var COMPODOC_CURRENT_PAGE_URL = 'future-roadmap.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>