periodicjs.ext.user_access_control
Version:
A user access control extension for Periodicjs that uses user roles and user privleges to controll access
88 lines (53 loc) • 2.34 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Index</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Index</h1>
<h3> </h3>
<section>
<article><h1>periodicjs.ext.user_access_control</h1>
<p>A User access control extension for Periodicjs that uses user roles and user privleges to controll access.</p>
<p> <a href="https://github.com/typesettin/periodicjs.ext.user_access_control/blob/master/doc/api.md">API Documentation</a></p>
<h2>Installation</h2>
<pre><code>$ npm install periodicjs.ext.user_access_control</code></pre>
<h2>Usage</h2>
<h3>Check Access Example</h3>
<pre><code class="lang-javascript">if(!User.hasPrivilege(req.user,110)){
next(new Error('EXT-UAC110: You don\'t have access to view content'));
}</code></pre>
<h2>Development</h2>
<p><em>Make sure you have grunt installed</em></p>
<pre><code>$ npm install -g grunt-cli</code></pre>
<p>Then run grunt watch</p>
<pre><code>$ grunt watch</code></pre>
<p>For generating documentation</p>
<pre><code>$ grunt doc
$ jsdoc2md controller/**/*.js index.js install.js uninstall.js > doc/api.md</code></pre>
<h2>Notes</h2>
<ul>
<li>Check out <a href="https://github.com/typesettin/periodicjs">https://github.com/typesettin/periodicjs</a> for the full Periodic Documentation</li>
</ul></article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-uacController.html">uacController</a></li><li><a href="module-userroleController.html">userroleController</a></li><li><a href="user_access_control.html">user_access_control</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Oct 12 2014 19:22:27 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>