UNPKG

sequelize-admin-panel

Version:
654 lines (179 loc) 7.94 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Module: sequelize-admin</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">Module: sequelize-admin</h1> <section> <header> </header> <article> <div class="container-overview"> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id=".cli"><span class="type-signature">(static) </span>cli<span class="type-signature"></span></h4> <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>cli</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">cli interface</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="index.js.html">index.js</a>, <a href="index.js.html#line85">line 85</a> </li></ul></dd> </dl> <h4 class="name" id=".ModelAdmin"><span class="type-signature">(static) </span>ModelAdmin<span class="type-signature"></span></h4> <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>ModelAdmin</code></td> <td class="type"> <span class="param-type"><a href="ModelAdmin.html">ModelAdmin</a></span> </td> <td class="description last">ModelAdmin base class</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="index.js.html">index.js</a>, <a href="index.js.html#line83">line 83</a> </li></ul></dd> </dl> <h4 class="name" id=".sequelizeAdmin"><span class="type-signature">(static) </span>sequelizeAdmin<span class="type-signature"></span></h4> <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>sequelizeAdmin</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">middleware builder</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="index.js.html">index.js</a>, <a href="index.js.html#line81">line 81</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="~sequelizeAdmin"><span class="type-signature">(inner) </span>sequelizeAdmin<span class="signature">(express, sequelizeInstance, { models, translation }<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {function}</span></h4> <div class="description"> Creates middleware </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>express</code></td> <td class="type"> <span class="param-type">Express</span> </td> <td class="attributes"> </td> <td class="description last">Express</td> </tr> <tr> <td class="name"><code>sequelizeInstance</code></td> <td class="type"> <span class="param-type">Sequelize.Instance</span> </td> <td class="attributes"> </td> <td class="description last">db connection</td> </tr> <tr> <td class="name"><code>{ models, translation }</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> &lt;optional><br> </td> <td class="description last">options</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="index.js.html">index.js</a>, <a href="index.js.html#line14">line 14</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> sequelize-admin middleware </div> <dl> <dt> Type </dt> <dd> <span class="param-type">function</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.html">sequelize-admin</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 Tue May 29 2018 16:25:38 GMT+0700 (+07) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>