@superawesome/permissions-nestjs
Version:
NestJS Guard & Decorators for @superawesome/permissions, promoting orthogonal fine-grained API access control to resources.
143 lines (110 loc) • 5.94 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 getting-started">
<div class="content-data">
<h1 id="superawesome-permissions-nestjs">SuperAwesome Permissions NestJS</h1>
<ul>
<li>npm package at <code>@superawesome/permissions-nestjs</code></li>
</ul>
<h2 id="contents">Contents</h2>
<p>The actual generated docs are at <code>npm run docs:serve</code> and <strong>coming soon</strong> at <a href="https://permissions-nestjs.docs.superawesome.com"><strong>SuperAwesome Permissions for NestJS Documentation</strong></a>. Go to the left, at the CompoDocs Nav Bar.</p>
<p><strong>NOTE: THESE LINKS BREAK ON GITHUB! (^^^ read above ^^^)</strong></p>
<ul>
<li><p><a href="/additional-documentation/introduction.html">Introduction</a></p>
</li>
<li><p><a href="/additional-documentation/how-to-use-simple-example.html">How to use & Simple Example</a>. </p>
</li>
<li><p><a href="/additional-documentation/reference-&-detailed-example.html">Detailed Example & Reference</a>.</p>
</li>
</ul>
<p><strong>Note</strong>: This is the underlying <a href="https://github.com/SuperAwesomeLTD/permissions">SuperAwesome Permissions</a> library.</p>
<h1 id="versioning">Versioning</h1>
<p>The project follows <a href="https://semver.org/">semantic versioning</a> which effectivelly means a new major version x.0.0 is released when there are breaking changes, minor 0.x.0 when there are new features and patch 0.0.x when there are fixes. </p>
<h1 id="how-to-develop">How to develop</h1>
<p><strong>IMPORTANT</strong>: do <code>npm install && npm run install-example</code> on project root before using! </p>
<h2 id="code">Code</h2>
<ul>
<li><p>Simply do an <code>npm run test:watch</code> to develop and test at each change.</p>
</li>
<li><p>With <code>npm run dev</code> you watch files building library at <code>/dist</code>.</p>
</li>
<li><p>With <code>npm run build:ts</code> you get a build of the library at <code>/dist</code>.</p>
</li>
<li><p>With <code>npm run build</code> you get a full build of library & docs at <code>/dist</code>.</p>
</li>
</ul>
<h2 id="documentation">Documentation</h2>
<p>End user docs reside at <code>src/docs</code>:</p>
<ul>
<li><p>With <code>npm run docs:build</code> it builds docs at <code>dist/docs</code> once.</p>
</li>
<li><p>With <code>npm run docs:serve</code> it serves docs at <a href="http://127.0.0.1:8091">http://127.0.0.1:8091</a> in non-watch mode.</p>
</li>
<li><p>With <code>npm run docs:watch</code> it serves docs at <a href="http://127.0.0.1:8091">http://127.0.0.1:8091</a> in watch mode.</p>
</li>
</ul>
</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 = 'getting-started';
var COMPODOC_CURRENT_PAGE_URL = 'index.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>