waibu-db
Version:
24 lines • 40.4 kB
HTML
<html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Module: CRUDHandler</title><!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">WaibuDb API</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="WaibuDb.html">WaibuDb</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-CRUDHandler.html">CRUDHandler</a></div><div class="sidebar-section-children"><a href="module-CRUDHandler_Helper.html">CRUDHandler/Helper</a></div><div class="sidebar-section-children"><a href="module-Helper.html">Helper</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-DoboModel.html">DoboModel</a></div><div class="sidebar-section-children"><a href="external-TFilter.html">TFilter</a></div><div class="sidebar-section-children"><a href="external-TOptions.html">TOptions</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/waibu-db" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/waibu-db" target="">Github</a></div><div class="navbar-item"><a id="" href="https://waibu.bajo.app/" target="">Waibu</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header></header><article><div class="container-overview"><div class="description"><p>Function handlers for CRUD operations.</p><p>To use these handlers, you need to import them first and call them with the appropriate parameters.</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_all-handler.js.html">lib/crud/all-handler.js</a>, <a href="lib_crud_all-handler.js.html#line10">line 10</a></li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id=".addHandler"><span class="type-signature">(async, static) </span>addHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Handler for rendering the add view of a model.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const addHandler = await importModule('waibuDb:/lib/crud/add-handler.js')
const result = await addHandler.call(this, { model: 'YourModelName', req, reply })
</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>template</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Template path</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>addOnsHandler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Add-ons handler function</p></td></tr><tr><td class="name"><code>templateDisabled</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'waibuDb.template:/disabled.html'</td><td class="description last"><p>Disabled template path</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_add-handler.js.html">lib/crud/add-handler.js</a>, <a href="lib_crud_add-handler.js.html#line24">line 24</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Renders the add view</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id=".allHandler"><span class="type-signature">(async, static) </span>allHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<any>}</span></h3><div class="description"><p>Handler for routing to the appropriate CRUD action based on the provided options.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const allHandler = await importModule('waibuDb:/lib/crud/all-handler.js')
const result = await allHandler.call(this, { model: 'YourModelName', action: 'list', req, reply })
</code></pre><p>For more information on the available actions, see <a href="module-CRUDHandler.html#.THandlerMap">THandlerMap</a>.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>action</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Action name</p></td></tr><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>template</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Template path</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_all-handler.js.html">lib/crud/all-handler.js</a>, <a href="lib_crud_all-handler.js.html#line64">line 64</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="module-CRUDHandler.html#.THandlerMap">THandlerMap</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Result of the handler</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<any></span></dd></dl></div><h3 class="name has-anchor" id=".deleteHandler"><span class="type-signature">(async, static) </span>deleteHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Handler for deleting records of a model.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const deleteHandler = await importModule('waibuDb:/lib/crud/delete-handler.js')
await deleteHandler.call(this, { model: 'YourModelName', req, reply })
</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>templateDisabled</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'waibuDb.template:/disabled.html'</td><td class="description last"><p>Disabled template path</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_delete-handler.js.html">lib/crud/delete-handler.js</a>, <a href="lib_crud_delete-handler.js.html#line22">line 22</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Redirects to the list view</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id=".detailsHandler"><span class="type-signature">(async, static) </span>detailsHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Handler for rendering the details view of a model.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const detailsHandler = await importModule('waibuDb:/lib/crud/details-handler.js')
const result = await detailsHandler.call(this, { model: 'YourModelName', req, reply })
</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Record ID</p></td></tr><tr><td class="name"><code>template</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Template path</p></td></tr><tr><td class="name"><code>addOnsHandler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Add-ons handler function</p></td></tr><tr><td class="name"><code>templateDisabled</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'waibuDb.template:/disabled.html'</td><td class="description last"><p>Disabled template path</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_details-handler.js.html">lib/crud/details-handler.js</a>, <a href="lib_crud_details-handler.js.html#line27">line 27</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Renders the details view</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id=".editHandler"><span class="type-signature">(async, static) </span>editHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Handler for rendering the edit view of a model.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const editHandler = await importModule('waibuDb:/lib/crud/edit-handler.js')
const result = await editHandler.call(this, { model: 'YourModelName', req, reply })
</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Record ID</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>template</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Template path</p></td></tr><tr><td class="name"><code>addOnsHandler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Add-ons handler function</p></td></tr><tr><td class="name"><code>templateDisabled</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'waibuDb.template:/disabled.html'</td><td class="description last"><p>Disabled template path</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_edit-handler.js.html">lib/crud/edit-handler.js</a>, <a href="lib_crud_edit-handler.js.html#line27">line 27</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Renders the edit view</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h3 class="name has-anchor" id=".exportHandler"><span class="type-signature">(async, static) </span>exportHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<void>}</span></h3><div class="description"><p>Handler for rendering the export view of a model.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const exportHandler = await importModule('waibuDb:/lib/crud/export-handler.js')
await exportHandler.call(this, { model: 'YourModelName', req, reply })
</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>templateDisabled</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'waibuDb.template:/disabled.html'</td><td class="description last"><p>Disabled template path</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_export-handler.js.html">lib/crud/export-handler.js</a>, <a href="lib_crud_export-handler.js.html#line24">line 24</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Redirect to the list view</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<void></span></dd></dl></div><h3 class="name has-anchor" id=".listHandler"><span class="type-signature">(async, static) </span>listHandler<span class="signature">(opts)</span><span class="type-signature"> → {Promise.<string>}</span></h3><div class="description"><p>Handle the list view for a given model, rendering the appropriate template with the retrieved data.</p><p>To use this handler, you must import it first and call it with the necessary parameters. For example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
const listHandler = await importModule('waibuDb:/lib/crud/list-handler.js')
const result = await listHandler.call(this, { model: 'YourModelName', req, reply })
</code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>opts</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>Options object</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>req</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Request object</p></td></tr><tr><td class="name"><code>reply</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Reply object</p></td></tr><tr><td class="name"><code>model</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Model name</p></td></tr><tr><td class="name"><code>template</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Template path</p></td></tr><tr><td class="name"><code>params</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Parameters for the template</p></td></tr><tr><td class="name"><code>addOnsHandler</code></td><td class="type"><span class="param-type">function</span></td><td class="attributes"><optional><br></td><td class="default"></td><td class="description last"><p>Add-ons handler function</p></td></tr><tr><td class="name"><code>templateDisabled</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"><optional><br></td><td class="default">'waibuDb.template:/disabled.html'</td><td class="description last"><p>Disabled template path</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">object</span></td><td class="attributes"><optional><br></td><td class="default">{}</td><td class="description last"><p>Additional options</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_list-handler.js.html">lib/crud/list-handler.js</a>, <a href="lib_crud_list-handler.js.html#line24">line 24</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>Renders the list view</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Promise.<string></span></dd></dl></div><h2 id="type-definitions" class="subsection-title has-anchor">Type Definitions</h2><h3 class="name has-anchor" id=".THandlerMap">THandlerMap</h3><div class="description"><p>Map of CRUD action names to their corresponding handler functions.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Object</span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>add</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Handler for the addHandler action</p></td></tr><tr><td class="name"><code>delete</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Handler for the deleteHandler action</p></td></tr><tr><td class="name"><code>details</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Handler for the detailsHandler action</p></td></tr><tr><td class="name"><code>edit</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Handler for the editHandler action</p></td></tr><tr><td class="name"><code>export</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Handler for the exportHandler action</p></td></tr><tr><td class="name"><code>list</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>Handler for the listHandler action</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_crud_all-handler.js.html">lib/crud/all-handler.js</a>, <a href="lib_crud_all-handler.js.html#line17">line 17</a></li></ul></dd></div></dl></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">WaibuDb API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/waibu-db" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/waibu-db" target="">Github</a></div><div class="navbar-item"><a id="" href="https://waibu.bajo.app/" target="">Waibu</a></div><div class="navbar-item"><a id="" href="https://bajo.app/" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="WaibuDb.html">WaibuDb</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-CRUDHandler.html">CRUDHandler</a></div><div class="sidebar-section-children"><a href="module-CRUDHandler_Helper.html">CRUDHandler/Helper</a></div><div class="sidebar-section-children"><a href="module-Helper.html">Helper</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="external-DoboModel.html">DoboModel</a></div><div class="sidebar-section-children"><a href="external-TFilter.html">TFilter</a></div><div class="sidebar-section-children"><a href="external-TOptions.html">TOptions</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#TConfig">TConfig</a></div><div class="sidebar-section-children"><a href="global.html#factory">factory</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>