Skip to content

Commit

Permalink
chore(release): 0.0.1
Browse files Browse the repository at this point in the history 
[skip ci]
  • Loading branch information
@GerkinDev
GerkinDev committed Oct 6, 2021
1 parent 97e000c commit ed472f7
Show file tree
Hide file tree
Showing 22 changed files with 6,176 additions and 0 deletions.
2,679 changes: 2,679 additions & 0 deletions docs/assets/css/main.css
View file

Large diffs are not rendered by default.

64 changes: 64 additions & 0 deletions docs/assets/css/pages.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
h2 code {
font-size: 1em;
}

h3 code {
font-size: 1em;
}

.tsd-navigation.primary ul {
border-bottom: none;
}

.tsd-navigation.primary li {
border-top: none;
}

.tsd-navigation li.label.pp-nav.pp-group:first-child span {
padding-top: 0;
}

.tsd-navigation li.label.pp-nav.pp-group {
font-weight: 700;
border-bottom: 1px solid #eee;
}

.tsd-navigation li.label.pp-nav.pp-group span {
color: #222;
}

.tsd-navigation li.pp-nav.pp-page.current {
background-color: #f8f8f8;
border-left: 2px solid #222;
}

.tsd-navigation li.pp-nav.pp-page.current a {
color: #222;
}

.tsd-navigation li.pp-nav.pp-page.pp-parent.pp-active {
border-left: 2px solid #eee;
}

.tsd-navigation li.pp-nav.pp-page.pp-child {
border-left: 2px solid #eee;
padding-left: 15px;
}

.tsd-navigation li.pp-nav.pp-page.pp-child.current {
border-left: 2px solid #222;
}

.tsd-kind-page .tsd-kind-icon:before {
display: inline-block;
vertical-align: middle;
height: 16px;
width: 16px;
content: "";
background-image: url("../images/page-icon.svg");
background-size: 16px 16px;
}

#tsd-search .results span.parent {
color: #b3b2b2 !important;
}
Binary file added docs/assets/images/icons.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/icons@2x.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/images/page-icon.svg
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/widgets.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/widgets@2x.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/js/main.js
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/js/search.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/assets/js/search.json
View file

Large diffs are not rendered by default.

255 changes: 255 additions & 0 deletions docs/classes/CaslModule.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,255 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CaslModule | @scitizen/nest-casl</title>
<meta name="description" content="Documentation for @scitizen/nest-casl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="stylesheet" href="../assets/css/pages.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">@scitizen/nest-casl</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-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</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="../modules.html">Globals</a>
</li>
<li>
<a href="CaslModule.html">CaslModule</a>
</li>
</ul>
<h1>Class CaslModule</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">CaslModule</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 ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CaslModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="CaslModule.html#withConfig" class="tsd-kind-icon">with<wbr>Config</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Casl<wbr>Module<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CaslModule.html" class="tsd-signature-type">CaslModule</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<h4 class="tsd-returns-title">Returns <a href="CaslModule.html" class="tsd-signature-type">CaslModule</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="withConfig" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> with<wbr>Config</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">with<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/ICaslRootConfig.html" class="tsd-signature-type">ICaslRootConfig</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DynamicModule</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Scitizen/nest-casl/blob/506beb8/src/casl.module.ts#L24">casl.module.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configure the CaslModule using the provided configuration.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>config: <a href="../interfaces/ICaslRootConfig.html" class="tsd-signature-type">ICaslRootConfig</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The module configuration to use.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DynamicModule</span></h4>
<p>the configured CaslModule</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label pp-nav pp-group">
<span>Guides</span>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Guides/getting-started.html">Getting started</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Guides/use-with-guards.html">Use with guards</a>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Guides/better-type-constraints.html">Better type constraints</a>
</li>
<li class="label pp-nav pp-group">
<span>Changelog</span>
</li>
<li class=" pp-nav pp-page">
<a href="../pages/Changelog/CHANGELOG.html">Changelog</a>
</li>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="CaslModule.html" class="tsd-kind-icon">Casl<wbr>Module</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="CaslModule.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="CaslModule.html#withConfig" class="tsd-kind-icon">with<wbr>Config</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/CaslAbilityFactory.html" class="tsd-kind-icon">Casl<wbr>Ability<wbr>Factory</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/ICaslRootConfig.html" class="tsd-kind-icon">ICasl<wbr>Root<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="../interfaces/IPolicy.html" class="tsd-kind-icon">IPolicy</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#BoundPolicyDecorators" class="tsd-kind-icon">Bound<wbr>Policy<wbr>Decorators</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#PolicyDescriptor" class="tsd-kind-icon">Policy<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#PolicyDescriptorMask" class="tsd-kind-icon">Policy<wbr>Descriptor<wbr>Mask</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../modules.html#SimplePolicy" class="tsd-kind-icon">Simple<wbr>Policy</a>
</li>
<li class=" tsd-kind-function">
<a href="../modules.html#InjectAbility" class="tsd-kind-icon">Inject<wbr>Ability</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../modules.html#PoliciesMask" class="tsd-kind-icon">Policies<wbr>Mask</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../modules.html#Policy" class="tsd-kind-icon">Policy</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="../modules.html#bindPolicyDecorators" class="tsd-kind-icon">bind<wbr>Policy<wbr>Decorators</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</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>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.json"><' + '/script>');</script>
</body>
</html>

0 comments on commit ed472f7

Please sign in to comment.