sequelize-admin-panel
Version:
Admin panel for sequelize ORM
2,176 lines (589 loc) • 24.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: SA</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">Namespace: SA</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="req.html">req</a>.</span>SA</h2>
</header>
<article>
<div class="container-overview">
<div class="description">Available as req.SA everywhere</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sequelizeInstance</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Sequelize instance</td>
</tr>
<tr>
<td class="name"><code>Sequelize</code></td>
<td class="type">
<span class="param-type">Sequelize</span>
</td>
<td class="description last">sequelize constructor</td>
</tr>
<tr>
<td class="name"><code>modelAdminManager</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">ModelAdminManager instance</td>
</tr>
<tr>
<td class="name"><code>modelName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">current model name from url</td>
</tr>
<tr>
<td class="name"><code>modelAdminInstance</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">ModelAdmin instance for current model</td>
</tr>
<tr>
<td class="name"><code>PERMISSION</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">user session permissions</td>
</tr>
<tr>
<td class="name"><code>utils</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><a href="req.SA.utils.html">req.SA.utils</a></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line6">line 6</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Namespaces</h3>
<dl>
<dt><a href="req.SA.utils.html">utils</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".checkPermission"><span class="type-signature">(static) </span>checkPermission<span class="signature">(req, action, modelName)</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
Check user permission
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>req</code></td>
<td class="type">
<span class="param-type">Express.Request</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>action</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>modelName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id=".formExtender"><span class="type-signature">(static) </span>formExtender<span class="signature">(extraParams, unsetParams)</span><span class="type-signature"> → {String}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>extraParams</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">new form params</td>
</tr>
<tr>
<td class="name"><code>unsetParams</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">params to unset, false means unset all</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_through-params.js.html">middleware/through-params.js</a>, <a href="middleware_through-params.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
html, set of hidden form inputs with params
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".formExtender"><span class="type-signature">(static) </span>formExtender<span class="signature">(extraParams, unsetParams)</span><span class="type-signature"> → {String}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>extraParams</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">new form params</td>
</tr>
<tr>
<td class="name"><code>unsetParams</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">params to unset, false means unset all</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_through-params-.js.html">middleware/through-params-.js</a>, <a href="middleware_through-params-.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
html, set of hidden form inputs with params
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".getSequelizeError"><span class="type-signature">(static) </span>getSequelizeError<span class="signature">(type, fieldName)</span><span class="type-signature"></span></h4>
<div class="description">
Get ValidationError
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">error type</td>
</tr>
<tr>
<td class="name"><code>fieldName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">field name on which error occured</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line69">line 69</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
<span class="param-type">Sequelize.ValidationError</span>
</div>
<h4 class="name" id=".queryExtender"><span class="type-signature">(static) </span>queryExtender<span class="signature">(pathParts, extraParams, unsetParams)</span><span class="type-signature"> → {String}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pathParts</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">url parts</td>
</tr>
<tr>
<td class="name"><code>extraParams</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">new url params</td>
</tr>
<tr>
<td class="name"><code>unsetParams</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">params to unset, false means unset all</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_through-params.js.html">middleware/through-params.js</a>, <a href="middleware_through-params.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
url
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".queryExtender"><span class="type-signature">(static) </span>queryExtender<span class="signature">(pathParts, extraParams, unsetParams)</span><span class="type-signature"> → {String}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pathParts</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">url parts</td>
</tr>
<tr>
<td class="name"><code>extraParams</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">new url params</td>
</tr>
<tr>
<td class="name"><code>unsetParams</code></td>
<td class="type">
<span class="param-type">Array</span>
|
<span class="param-type">String</span>
</td>
<td class="description last">params to unset, false means unset all</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_through-params-.js.html">middleware/through-params-.js</a>, <a href="middleware_through-params-.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
url
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".tr"><span class="type-signature">(static) </span>tr<span class="signature">(message, default)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
Translates message
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>default</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line37">line 37</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".trAction"><span class="type-signature">(static) </span>trAction<span class="signature">(actionName, default)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
Translates action name
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>actionName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>default</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line61">line 61</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".trField"><span class="type-signature">(static) </span>trField<span class="signature">(modelName, fieldName, default)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
Translates field name
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>modelName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>fieldName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>default</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id=".trModel"><span class="type-signature">(static) </span>trModel<span class="signature">(modelAdmin)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
Translates model name
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>modelAdmin</code></td>
<td class="type">
<span class="param-type"><a href="ModelAdmin.html">ModelAdmin</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="middleware_extend-request.js.html">middleware/extend-request.js</a>, <a href="middleware_extend-request.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
{ label, plural, hint}
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-cli.html">cli</a></li><li><a href="module-sequelize-admin-panel.html">sequelize-admin-panel</a></li></ul><h3>Classes</h3><ul><li><a href="ModelAdmin.html">ModelAdmin</a></li><li><a href="ModelAdminManager.html">ModelAdminManager</a></li></ul><h3>Namespaces</h3><ul><li><a href="req.html">req</a></li><li><a href="req.SA.html">SA</a></li><li><a href="req.SA.utils.html">utils</a></li><li><a href="res.html">res</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed May 30 2018 09:23:34 GMT+0700 (+07)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>