UNPKG

dobo

Version:

DBMS for Bajo Framework

github.com/ardhi/dobo

ardhi/dobo

15 lines • 41.6 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!DOCTYPE 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: Hook</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">Dobo 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="Dobo.html">Dobo</a></div><div class="sidebar-section-children"><a href="DoboAction.html">DoboAction</a></div><div class="sidebar-section-children"><a href="DoboAdapter.html">DoboAdapter</a></div><div class="sidebar-section-children"><a href="DoboConnection.html">DoboConnection</a></div><div class="sidebar-section-children"><a href="DoboFeature.html">DoboFeature</a></div><div class="sidebar-section-children"><a href="DoboModel.html">DoboModel</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-Helper.html">Helper</a></div><div class="sidebar-section-children"><a href="module-Helper_Model.html">Helper/Model</a></div><div class="sidebar-section-children"><a href="module-Hook.html">Hook</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-Tools.html">Tools</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#actionFactory">actionFactory</a></div><div class="sidebar-section-children"><a href="global.html#adapterFactory">adapterFactory</a></div><div class="sidebar-section-children"><a href="global.html#connectionFactory">connectionFactory</a></div><div class="sidebar-section-children"><a href="global.html#featureFactory">featureFactory</a></div><div class="sidebar-section-children"><a href="global.html#modelFactory">modelFactory</a></div><div class="sidebar-section-children"><a href="global.html#pluginFactory">pluginFactory</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/dobo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/dobo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://dobo.bajo.app/" target="">Dobo</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>Available hooks for Dobo's operations. You can use these hooks to customize the behavior of the model's CRUD operations.</p><p>For any of the hooks below, you can also use the <code>modelName</code> in camelCase format to create a model-specific hook. If you choose to use this format, you must omit the first parameter (<code>model</code>) so that the hook function handler syntax will become like this:</p><pre class="prettyprint source lang-js"><code>dobo.{modelName}:beforeCreateRecord (body, options) dobo.{modelName}:afterCreateRecord (body, options) dobo.{modelName}:beforeFindRecord (filter, options) dobo.{modelName}:afterFindRecord (filter, result, options) ... </code></pre><p>You can use both formats simultaneously if you want. In that case, they will be executed in this order:</p><pre class="prettyprint source lang-js"><code>dobo:beforeCreateRecord (model, body, options) dobo.{modelName}:beforeCreateRecord (body, options) ... dobo.{modelName}:afterCreateRecord (body, result, options) dobo:afterCreateRecord (model, body, result, options) </code></pre><p>For both formats, there are their counterparts that run deep inside the adapter. Only use these hooks if you know what you are doing.</p><p>Their syntax is similar to the above, with one exception: you need to put suffix <code>.adapter</code> after <code>dobo</code>:</p><pre class="prettyprint source lang-js"><code>dobo.adapter:beforeAdapterCreateRecord (model, body, options) dobo.adapter.{modelName}:beforeAdapterCreateRecord (body, options) </code></pre></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line1">line 1</a></li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id=".dobo:afterCountRecord"><span class="type-signature">(async, static) </span>dobo:afterCountRecord<span class="signature">(model, filter, result, options)</span></h3><div class="description"><p>Hook that is called after counting records.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria that was applied when counting records</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">DoboModel.<wbr>TResultCountRecord</span></td><td class="description last"><p>The result of the count operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line200">line 200</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterCreateRecord"><span class="type-signature">(async, static) </span>dobo:afterCreateRecord<span class="signature">(model, body, result, options)</span></h3><div class="description"><p>Hook that is called after creating a record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>body</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The body payload to be created</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TResultRecord">DoboModel.<wbr>TResultRecord</a></span></td><td class="description last"><p>The result of the create operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line47">line 47</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterFindAllRecord"><span class="type-signature">(async, static) </span>dobo:afterFindAllRecord<span class="signature">(model, filter, result, options)</span></h3><div class="description"><p>Hook that is called after finding all records.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria applied when finding all records</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">DoboModel.<wbr>TResultFindAllRecord</span></td><td class="description last"><p>The result of the find all operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line123">line 123</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterFindOneRecord"><span class="type-signature">(async, static) </span>dobo:afterFindOneRecord<span class="signature">(model, filter, result, options)</span></h3><div class="description"><p>Hook that is called after finding one record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria applied when finding one record</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type">DoboModel.<wbr>TResultFindOneRecord</span></td><td class="description last"><p>The result of the find one operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line98">line 98</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterFindRecord"><span class="type-signature">(async, static) </span>dobo:afterFindRecord<span class="signature">(model, filter, result, options)</span></h3><div class="description"><p>Hook that is called after finding records.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria applied when finding records</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TResultFindRecord">DoboModel.<wbr>TResultFindRecord</a></span></td><td class="description last"><p>The result of the find operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line72">line 72</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterGetRecord"><span class="type-signature">(async, static) </span>dobo:afterGetRecord<span class="signature">(model, id, result, options)</span></h3><div class="description"><p>Hook that is called after getting a record by ID.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the record that was retrieved</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TResultGetRecord">DoboModel.<wbr>TResultGetRecord</a></span></td><td class="description last"><p>The result of the get operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line225">line 225</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterRemoveRecord"><span class="type-signature">(async, static) </span>dobo:afterRemoveRecord<span class="signature">(model, id, result, options)</span></h3><div class="description"><p>Hook that is called after removing a record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the record that was removed</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TResultRemoveRecord">DoboModel.<wbr>TResultRemoveRecord</a></span></td><td class="description last"><p>The result of the remove operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line175">line 175</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:afterUpdateRecord"><span class="type-signature">(async, static) </span>dobo:afterUpdateRecord<span class="signature">(model, id, body, result, options)</span></h3><div class="description"><p>Hook that is called after updating a record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the record that was updated</p></td></tr><tr><td class="name"><code>body</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The body payload that was updated</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TResultUpdateRecord">DoboModel.<wbr>TResultUpdateRecord</a></span></td><td class="description last"><p>The result of the update operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line149">line 149</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeCountRecord"><span class="type-signature">(async, static) </span>dobo:beforeCountRecord<span class="signature">(model, filter, options)</span></h3><div class="description"><p>Hook that is called before counting records.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria to apply when counting records</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line188">line 188</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeCreateRecord"><span class="type-signature">(async, static) </span>dobo:beforeCreateRecord<span class="signature">(model, body, options)</span></h3><div class="description"><p>Hook that is called before creating a record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>body</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The body payload to be created</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line35">line 35</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeFindAllRecord"><span class="type-signature">(async, static) </span>dobo:beforeFindAllRecord<span class="signature">(model, filter, options)</span></h3><div class="description"><p>Hook that is called before finding all records.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria to apply when finding all records</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line111">line 111</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeFindOneRecord"><span class="type-signature">(async, static) </span>dobo:beforeFindOneRecord<span class="signature">(model, filter, result, options)</span></h3><div class="description"><p>Hook that is called before finding one record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria to apply when finding one record</p></td></tr><tr><td class="name"><code>result</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TResultFindRecord">DoboModel.<wbr>TResultFindRecord</a></span></td><td class="description last"><p>The result of the find operation</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line85">line 85</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeFindRecord"><span class="type-signature">(async, static) </span>dobo:beforeFindRecord<span class="signature">(model, filter, options)</span></h3><div class="description"><p>Hook that is called before finding records.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>filter</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TFilter">DoboModel.<wbr>TFilter</a></span></td><td class="description last"><p>The filter criteria to apply when finding records</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line60">line 60</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeGetRecord"><span class="type-signature">(async, static) </span>dobo:beforeGetRecord<span class="signature">(model, id, options)</span></h3><div class="description"><p>Hook that is called before getting a record by ID.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the record to be retrieved</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line213">line 213</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeRemoveRecord"><span class="type-signature">(async, static) </span>dobo:beforeRemoveRecord<span class="signature">(model, id, options)</span></h3><div class="description"><p>Hook that is called before removing a record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the record to be removed</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line163">line 163</a></li></ul></dd></div></dl><h3 class="name has-anchor" id=".dobo:beforeUpdateRecord"><span class="type-signature">(async, static) </span>dobo:beforeUpdateRecord<span class="signature">(model, id, body, options)</span></h3><div class="description"><p>Hook that is called before updating a record.</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>model</code></td><td class="type"><span class="param-type"><a href="DoboModel.html">DoboModel</a></span></td><td class="description last"><p>The model instance</p></td></tr><tr><td class="name"><code>id</code></td><td class="type"><span class="param-type">string</span> |<wbr> <span class="param-type">number</span></td><td class="description last"><p>The ID of the record to be updated</p></td></tr><tr><td class="name"><code>body</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The body payload to be updated</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type"><a href="DoboModel.html#.TOptions">DoboModel.<wbr>TOptions</a></span></td><td class="description last"><p>The options object</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="extend_bajo_hook-docs.js.html">extend/bajo/hook-docs.js</a>, <a href="extend_bajo_hook-docs.js.html#line136">line 136</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">Dobo API</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/dobo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/dobo" target="">Github</a></div><div class="navbar-item"><a id="" href="https://dobo.bajo.app/" target="">Dobo</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="Dobo.html">Dobo</a></div><div class="sidebar-section-children"><a href="DoboAction.html">DoboAction</a></div><div class="sidebar-section-children"><a href="DoboAdapter.html">DoboAdapter</a></div><div class="sidebar-section-children"><a href="DoboConnection.html">DoboConnection</a></div><div class="sidebar-section-children"><a href="DoboFeature.html">DoboFeature</a></div><div class="sidebar-section-children"><a href="DoboModel.html">DoboModel</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-Helper.html">Helper</a></div><div class="sidebar-section-children"><a href="module-Helper_Model.html">Helper/Model</a></div><div class="sidebar-section-children"><a href="module-Hook.html">Hook</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-Tools.html">Tools</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#actionFactory">actionFactory</a></div><div class="sidebar-section-children"><a href="global.html#adapterFactory">adapterFactory</a></div><div class="sidebar-section-children"><a href="global.html#connectionFactory">connectionFactory</a></div><div class="sidebar-section-children"><a href="global.html#featureFactory">featureFactory</a></div><div class="sidebar-section-children"><a href="global.html#modelFactory">modelFactory</a></div><div class="sidebar-section-children"><a href="global.html#pluginFactory">pluginFactory</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>