UNPKG

sequelize-admin-panel

Version:
545 lines (144 loc) 7.03 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: ModelAdminManager</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">Class: ModelAdminManager</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>ModelAdminManager<span class="signature">(sequelizeInstance, modelAdmins)</span><span class="type-signature"></span></h2> <div class="class-description">Manage ModelAdmin instances</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="ModelAdminManager"><span class="type-signature"></span>new ModelAdminManager<span class="signature">(sequelizeInstance, modelAdmins)</span><span class="type-signature"></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>sequelizeInstance</code></td> <td class="type"> <span class="param-type">Sequelize.Instance</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>modelAdmins</code></td> <td class="type"> <span class="param-type"><a href="ModelAdminManager.html#~modelAdmins">ModelAdminManager~modelAdmins</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="ModelAdminManager_index.js.html">ModelAdminManager/index.js</a>, <a href="ModelAdminManager_index.js.html#line7">line 7</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="modelAdminList"><span class="type-signature">(readonly) </span>modelAdminList<span class="type-signature"> :array.&lt;<a href="ModelAdmin.html">ModelAdmin</a>></span></h4> <div class="description"> property getter for <a href="ModelAdmin.html">ModelAdmin</a> instances, same order it was passed to constructor </div> <h5>Type:</h5> <ul> <li> <span class="param-type">array.&lt;<a href="ModelAdmin.html">ModelAdmin</a>></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="ModelAdminManager_index.js.html">ModelAdminManager/index.js</a>, <a href="ModelAdminManager_index.js.html#line58">line 58</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="getModelAdminByModelName"><span class="type-signature"></span>getModelAdminByModelName<span class="signature">(modelName)</span><span class="type-signature"></span></h4> <div class="description"> Get ModelAdmin instance by 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>modelName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">model name</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="ModelAdminManager_index.js.html">ModelAdminManager/index.js</a>, <a href="ModelAdminManager_index.js.html#line49">line 49</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> instance of <a href="ModelAdmin.html">ModelAdmin</a> </div> <h3 class="subsection-title">Type Definitions</h3> <h4 class="name" id="~modelAdmins">modelAdmins</h4> <div class="description"> Array of two-elements arrays with Sequelize.Model and ModelAdmin members, e.g. <pre>[ [ItemModel, ItemAdminModel], ... ]</pre> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Array.&lt;Array.&lt;Sequelize.Model, <a href="ModelAdmin.html">ModelAdmin</a>>></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="ModelAdminManager_index.js.html">ModelAdminManager/index.js</a>, <a href="ModelAdminManager_index.js.html#line65">line 65</a> </li></ul></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>