-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathioc.html
116 lines (113 loc) · 105 KB
/
ioc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>IoC | Axe API</title>
<meta name="generator" content="VitePress v1.3.4">
<link rel="preload stylesheet" href="/assets/style.D2wWT-OU.css" as="style">
<script type="module" src="/assets/app.BuAYJVRv.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.BxoX7LQB.js">
<link rel="modulepreload" href="/assets/chunks/framework.DgZLXPSQ.js">
<link rel="modulepreload" href="/assets/reference_ioc.md.B-boVLXn.lean.js">
<link rel="icon" href="/logo.png">
<meta name="theme-color" content="#3eaf7c">
<meta name="apple-mobile-web-app-capable" content="yes">
<link rel="stylesheet" href="/styles.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v2.9.1/dist/cookieconsent.css">
<meta name="description" content="Axe API is the next generation rest API framework. You can quickly create a Rest API by simply defining models and relationships.">
<meta name="og:title" content="Axe API">
<meta name="og:description" content="Axe API is the next generation rest API framework. You can quickly create a Rest API by simply defining models and relationships.">
<meta name="og:image" content="https://axe-api.com/social.png">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Axe API">
<meta name="twitter:description" content="Axe API is the next generation rest API framework. You can quickly create a Rest API by simply defining models and relationships.">
<meta name="twitter:image" content="https://axe-api.com/social.png">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon" href="/icons/apple-touch-icon-152x152.png">
<link rel="mask-icon" href="/icons/safari-pinned-tab.svg" color="#3eaf7c">
<meta name="msapplication-TileImage" content="/icons/msapplication-icon-144x144.png">
<meta name="msapplication-TileColor" content="#000000">
<script defer src="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v2.9.1/dist/cookieconsent.js"></script>
<script defer src="/init.js"></script>
<script async type="text/plain" data-cookiecategory="analytics" src="https://www.googletagmanager.com/gtag/js?id=G-1HBM031QWE"></script>
<script type="text/plain" data-cookiecategory="analytics">
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-1HBM031QWE');
</script>
<script id="check-dark-mode">document.documentElement.classList.add("dark");</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-a4de5d60 data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-6aa21345><div class="wrapper" data-v-6aa21345><div class="container" data-v-6aa21345><div class="title" data-v-6aa21345><div class="VPNavBarTitle has-sidebar" data-v-6aa21345 data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><img class="VPImage logo" src="/axe.png" alt data-v-8426fc1a><!--]--><span data-v-ab179fa1>Axe API</span><!--[--><!--]--></a></div></div><div class="content" data-v-6aa21345><div class="content-body" data-v-6aa21345><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6aa21345><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6aa21345 data-v-dc692963><span id="main-nav-aria-label" class="visually-hidden" data-v-dc692963> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/learn/quick-start.html" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>Learn</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/reference/api-configs.html" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>API Reference</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/blog/index.html" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>Blog</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-dc692963 data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-b6c34ac9><span class="text" data-v-b6c34ac9><!----><span data-v-b6c34ac9>Upgrading</span><span class="vpi-chevron-down text-icon" data-v-b6c34ac9></span></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-b98bc113><div class="items" data-v-b98bc113><!--[--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/upgrading/versioning-policy.html" data-v-43f1e123><!--[-->Versioning Policy<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/upgrading/v1.html" data-v-43f1e123><!--[-->v1 (stable)<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/upgrading/0.30.0.html" data-v-43f1e123><!--[-->v0.30<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/upgrading/0.20.0.html" data-v-43f1e123><!--[-->v0.20<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link vp-external-link-icon" href="https://github.com/axe-api/axe-api/releases" target="_blank" rel="noreferrer" data-v-43f1e123><!--[-->Releases<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link vp-external-link-icon" href="https://github.com/axe-api/axe-api/blob/master/CHANGELOG.md" target="_blank" rel="noreferrer" data-v-43f1e123><!--[-->Changelog<!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-dc692963 data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-b6c34ac9><span class="text" data-v-b6c34ac9><!----><span data-v-b6c34ac9>Ecosystem</span><span class="vpi-chevron-down text-icon" data-v-b6c34ac9></span></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-b98bc113><div class="items" data-v-b98bc113><!--[--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/ecosystem/support.html" data-v-43f1e123><!--[-->Support<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/ecosystem/faq.html" data-v-43f1e123><!--[-->FAQ<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link" href="/ecosystem/team.html" data-v-43f1e123><!--[-->Team<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link vp-external-link-icon" href="https://github.com/axe-api/axe-magic" target="_blank" rel="noreferrer" data-v-43f1e123><!--[-->CLI<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link vp-external-link-icon" href="https://sonarcloud.io/dashboard?id=axe-api_axe-api" target="_blank" rel="noreferrer" data-v-43f1e123><!--[-->SonarCloud<!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-dc692963 data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-b6c34ac9><span class="text" data-v-b6c34ac9><!----><span data-v-b6c34ac9>v1</span><span class="vpi-chevron-down text-icon" data-v-b6c34ac9></span></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-b98bc113><div class="items" data-v-b98bc113><!--[--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link vp-external-link-icon" href="https://axe-api.com" target="_blank" rel="noreferrer" data-v-43f1e123><!--[-->v1 (stable)<!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-b98bc113 data-v-43f1e123><a class="VPLink link vp-external-link-icon" href="https://legacy.axe-api.com" target="_blank" rel="noreferrer" data-v-43f1e123><!--[-->v0.30<!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/axe-api/axe-api" target="_blank" rel="noreferrer" tabindex="0" data-v-dc692963 data-v-9c663999><!--[--><span data-v-9c663999>GitHub</span><!--]--></a><!--]--><!--]--></nav><!----><!----><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6aa21345 data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/axe-api/axe-api" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="https://twitter.com/axeapi" aria-label="twitter" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-twitter" /></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-6aa21345 data-v-bb2aa2f0 data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b6c34ac9><span class="vpi-more-horizontal icon" data-v-b6c34ac9></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-b98bc113><!----><!--[--><!--[--><!----><!----><div class="group" data-v-bb2aa2f0><div class="item social-links" data-v-bb2aa2f0><div class="VPSocialLinks social-links-list" data-v-bb2aa2f0 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://github.com/axe-api/axe-api" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="https://twitter.com/axeapi" aria-label="twitter" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-twitter" /></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6aa21345 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-6aa21345><div class="divider-line" data-v-6aa21345></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-17a5e62e><button data-v-17a5e62e>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-319d5ca6><div class="curtain" data-v-319d5ca6></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-319d5ca6><span class="visually-hidden" id="sidebar-aria-label" data-v-319d5ca6> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Configs</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/api-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>API configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/pino-logger-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Pino (logger) configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/rate-limit-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Rate limit configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/database-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Database configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/cache-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Cache configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/redis-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Redis configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/elastic-search-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Elasticsearch configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/search-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Search configs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/version-configs.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Version configs</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Initialization</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/on-before-init.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeInit()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/on-after-init.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterInit()</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible has-active" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Axe API</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/app.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>App</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/icontext.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>IContext</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/axe-request.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>AxeRequest</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/axe-response.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>AxeResponse</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/ioc.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>IoC</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/api-error.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>ApiError</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/errors.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Error Codes</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Models</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-table.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>table()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-primary-key.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>primaryKey()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-fillable.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>fillable()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-validations.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>validations()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-hiddens.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>hiddens()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-created-at-column.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>createdAtColumn()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-updated-at-column.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>updatedAtColumn()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-deleted-at-column.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>deletedAtColumn()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-handlers.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>handlers()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-middlewares.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>middlewares()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-transactions.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>transactions()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-limits.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>limits()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-cache.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>cache()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-search.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>search()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-get-search-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>getSearchQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/model-ignore.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>ignore()</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Handlers</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/default-handlers.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>Defaults</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-insert-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>INSERT</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-paginate-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>PAGINATE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-show-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>SHOW</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-update-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>UPDATE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-delete-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>DELETE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-force-delete-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>FORCE_DELETE</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-patch-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>PATCH</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-all-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>ALL</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/handlers-search-handler.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>SEARCH</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Queries</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-fields.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>fields</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-sort.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>sort</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-page.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>page</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-per-page.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>per_page</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-trashed.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>trashed</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-q.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>q</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/queries-with.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>with</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Hooks & Events</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-insert.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeInsert()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-update-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeUpdateQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-update.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeUpdate()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-patch-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforePatchQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-patch.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforePatch()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-delete-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeDeleteQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-delete.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeDelete()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-force-delete-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeForceDeleteQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-force-delete.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeForceDelete()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-paginate.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforePaginate()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-all.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeAll()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-search.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeSearch()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-before-show.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onBeforeShow()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-insert.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterInsert()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-update-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterUpdateQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-update.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterUpdate()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-patch-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterPatchQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-patch.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterPatch()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-delete-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterDeleteQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-delete.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterDelete()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-force-delete-query.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterForceDeleteQuery()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-force-delete.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterForceDelete()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-paginate.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterPaginate()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-all.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterAll()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-search.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterSearch()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/hooks-events-on-after-show.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>onAfterShow()</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0 collapsible collapsed" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Axe API Client</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b7550ba0><span class="vpi-chevron-right caret-icon" data-v-b7550ba0></span></div></div><div class="items" data-v-b7550ba0><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-set-config.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>setConfig()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-add-request.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>addRequest()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-add-response.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>addResponse()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-first.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>first()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-resource.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>resource()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-insert.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>insert()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-update.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>update()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-patch.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>patch()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-delete.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>delete()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-paginate.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>paginate()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-with.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>with()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-where.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>where()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-or-where.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>orWhere()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-and-where.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>andWhere()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-where-like.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>whereLike()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-where-in.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>whereIn()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-where-between.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>whereBetween()</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/reference/client-where-null.html" data-v-b7550ba0><!--[--><p class="text" data-v-b7550ba0>whereNull()</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-3f215769 data-v-a5bbad30><div class="content" data-v-a5bbad30><div class="outline-marker" data-v-a5bbad30></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a5bbad30>On this page</div><ul class="VPDocOutlineItem root" data-v-a5bbad30 data-v-b933a997><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _reference_ioc" data-v-39a288b8><div><h1 id="ioc" tabindex="-1">IoC <a class="header-anchor" href="#ioc" aria-label="Permalink to "IoC""></a></h1><p><strong>Inversion of Control</strong> (IoC) is a design principle (although, some people refer to it as a pattern). As the name suggests, it is used to invert different kinds of controls in object-oriented design to achieve loose coupling. <a href="https://www.tutorialsteacher.com/ioc/inversion-of-control" target="_blank" rel="noreferrer">[*]</a></p><p>Axe API provides a simple IoC structure to create testable codes. Let's review the following hook;</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IContext } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onBeforeInsert</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ({ </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">formData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> IContext</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // formData.email: the new user's email address</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // TODO: Check if the email is already used</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { onBeforeInsert };</span></span></code></pre></div><p>Let's assume that we want to check if the email is already used in the database. To do that, we need a database connection. But Axe API already has a database connection. With IoC, you can use the database connection like the following example;</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IoCService, IContext } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { Knex } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "knex"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onBeforeInsert</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ({ </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">formData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> IContext</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> db</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">use</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">Knex</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">>(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Database"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> user</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> db.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">table</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"users"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">where</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"email"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, formData.email).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">first</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { onBeforeInsert };</span></span></code></pre></div><p>As you may see in the example, you can get the database connection from IoC. There are some objects which are provided by Axe API for you such as Database or Config. On the other hand, you can use the IoC to define and use your objects.</p><h2 id="internal" tabindex="-1">Internal <a class="header-anchor" href="#internal" aria-label="Permalink to "Internal""></a></h2><p>Axe API provides the following instances for you as default.</p><h3 id="config-singleton" tabindex="-1"><code>Config (Singleton)</code> <a class="header-anchor" href="#config-singleton" aria-label="Permalink to "`Config (Singleton)`""></a></h3><p><code>Config</code> is an instance of your application's configuration.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IoCService, IApplicationConfig } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onBeforePaginate</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> Config</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">use</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">IApplicationConfig</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">>(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Config"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(Config.Application.env); </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// development</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { onBeforePaginate };</span></span></code></pre></div><p>You may find more detail in the <a href="/reference/api-configs.html">Config</a> documentation.</p><h3 id="database-singleton" tabindex="-1"><code>Database (Singleton)</code> <a class="header-anchor" href="#database-singleton" aria-label="Permalink to "`Database (Singleton)`""></a></h3><p>You can access the <a href="https://knexjs.org/#Installation-client" target="_blank" rel="noreferrer">Knex.js' connection instance</a>.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IoCService, IContext } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { Knex } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "knex"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onBeforeInsert</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ({ </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">formData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> IContext</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> db</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">use</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">Knex</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">>(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Database"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { onBeforeInsert };</span></span></code></pre></div><h2 id="extending" tabindex="-1">Extending <a class="header-anchor" href="#extending" aria-label="Permalink to "Extending""></a></h2><p>In Axe API, you can define your definitions. <code>app/v1/init.ts</code> file is the best place to put your definitions. Because, after Axe API analyze the application, it calls the <code>init</code> function to handle your custom logic.</p><p>You can review the following example;</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { App, IoCService, IApplicationConfig } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> MyClass </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "my-class"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> Mailer </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "some-mail-library"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onBeforeInit</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">app</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> App</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Best place to define your IoC definitions.</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">singleton</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"MyClass"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> MyClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">bind</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Mailer"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> Config</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">use</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">IApplicationConfig</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">>(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"Config"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> Mailer</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(Config.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">SMTP</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onAfterInit</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">app</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> App</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { onBeforeInit, onAfterInit };</span></span></code></pre></div><h2 id="methods" tabindex="-1">Methods <a class="header-anchor" href="#methods" aria-label="Permalink to "Methods""></a></h2><h3 id="async-use-t-name" tabindex="-1"><code>async use<T>(name)</code> <a class="header-anchor" href="#async-use-t-name" aria-label="Permalink to "`async use<T>(name)`""></a></h3><p>With <code>use</code> method, you can get the instance from IoC.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IoCService, IContext } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onBeforeInsert</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ({ </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">formData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> IContext</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> db</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">use</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"><</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">MyClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">>(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"MyClass"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { onBeforeInsert };</span></span></code></pre></div><h3 id="bind-name-callback" tabindex="-1"><code>bind(name, callback)</code> <a class="header-anchor" href="#bind-name-callback" aria-label="Permalink to "`bind(name, callback)`""></a></h3><p>With <code>bind</code> method, you can define a relationship. In this way, whenever you want to use it, your callback function will be executed again.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IoCService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">class</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> MyClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {}</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">bind</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"MyClass"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> MyClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h3 id="singleton-name-callback" tabindex="-1"><code>singleton(name, callback)</code> <a class="header-anchor" href="#singleton-name-callback" aria-label="Permalink to "`singleton(name, callback)`""></a></h3><p>In software engineering, the singleton pattern is a software design pattern that restricts the instantiation of a class to one "single" instance. <a href="https://en.wikipedia.org/wiki/Singleton_pattern" target="_blank" rel="noreferrer">[*]</a> With this method, you can define a singleton relationship with your object.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { IoCService } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "axe-api"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">class</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> MyClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {}</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">IoCService.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">singleton</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"MyClass"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> MyClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>In this example, <code>IoCService.use</code> call, your callback function will be called only once. In the next usages, the results of your function will be returned automatically.</p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><!--[--><!--]--><div class="edit-info" data-v-e257564d><div class="edit-link" data-v-e257564d><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/axe-api/docs/edit/master/docs/reference/ioc.md" target="_blank" rel="noreferrer" data-v-e257564d><!--[--><span class="vpi-square-pen edit-link-icon" data-v-e257564d></span> Edit this page on GitHub<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d><a class="VPLink link pager-link prev" href="/reference/axe-response.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Previous page</span><span class="title" data-v-e257564d>AxeResponse</span><!--]--></a></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/reference/api-error.html" data-v-e257564d><!--[--><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>ApiError</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5d98c3a5 data-v-e315a0ad><div class="container" data-v-e315a0ad><p class="message" data-v-e315a0ad>Released under the MIT License.</p><p class="copyright" data-v-e315a0ad>Copyright © 2020-present</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"404.md\":\"DBrGGMqk\",\"blog_2021-07-27-a-new-approach-to-create-apis.md\":\"DHGX6jRU\",\"blog_2021-09-21-how-to-create-an-axe-api-from-scratch.md\":\"f87ALr3w\",\"blog_2023-12-24-axe-api-v1-is-out.md\":\"B460WYJa\",\"blog_2024-02-18-axe-api-v1-is-out.md\":\"Cmwf-oK-\",\"blog_2024-03-16-axe-api-v1-2-is-out.md\":\"sszNXTmV\",\"blog_2024-04-08-axe-api-v1-3-is-out.md\":\"CEKwEj-l\",\"blog_2024-04-21-axe-api-v1-4-is-out.md\":\"DNeUkEAg\",\"blog_2024-11-19-axe-api-v1-5-is-out.md\":\"lgXQpL7t\",\"blog_2025-01-02-axe-api-v1-6-is-out.md\":\"qF98Z6Fu\",\"blog_index.md\":\"B5BNfFG8\",\"ecosystem_faq.md\":\"COwcsvf0\",\"ecosystem_support.md\":\"Dl700XA0\",\"ecosystem_team.md\":\"BoUdgyXD\",\"errors.md\":\"BMFOxdHK\",\"index.md\":\"Bulr5Qr2\",\"learn_application-logic.md\":\"c05FdG3O\",\"learn_authentication.md\":\"tWCuz3di\",\"learn_bookstore-api.md\":\"CnHpY6n5\",\"learn_caching.md\":\"B2JFVRw0\",\"learn_configurations.md\":\"d9ia1dnU\",\"learn_contribution-tests.md\":\"BomXrVSf\",\"learn_contribution.md\":\"D8r__2zG\",\"learn_database-migrations.md\":\"C2fPzORZ\",\"learn_database-transactions.md\":\"Box8bLLF\",\"learn_db-analyzer.md\":\"Cw3-H0Lq\",\"learn_deployment.md\":\"B1iANop2\",\"learn_dev-kit-databases.md\":\"BIUyeF__\",\"learn_development-kit.md\":\"DtyImxs-\",\"learn_documentation.md\":\"uBl7QFvh\",\"learn_error-handling.md\":\"DjBw5-ol\",\"learn_file-uploading.md\":\"D5c2yV6Y\",\"learn_full-text-search.md\":\"DUdRn8p1\",\"learn_hooks-and-events.md\":\"DnXj0uRJ\",\"learn_i18n.md\":\"Y6ThEGM-\",\"learn_javascript-client-axe-api-client.md\":\"DIkUKxCX\",\"learn_middlewares.md\":\"xZKSCgPe\",\"learn_models.md\":\"CcyHn3IU\",\"learn_querying-data.md\":\"DKWtqhct\",\"learn_quick-start.md\":\"33PkmWIv\",\"learn_rate-limiting.md\":\"DJ4dkoNZ\",\"learn_related-data-queries.md\":\"BVncZ4ok\",\"learn_request-response-cycle.md\":\"YUDG_cdJ\",\"learn_routing.md\":\"B5_A7PCm\",\"learn_serializers.md\":\"CKFnqA9N\",\"learn_serving-static-files.md\":\"DzzQ2GqP\",\"learn_testing.md\":\"D4JNTbP8\",\"learn_validations.md\":\"BboK8d9e\",\"learn_version-management.md\":\"8LhAokZa\",\"privacy-policy.md\":\"D35U8GW9\",\"reference_api-configs.md\":\"B0WlTg4j\",\"reference_api-error.md\":\"Cy0_oaRR\",\"reference_app.md\":\"CBJRoLgI\",\"reference_axe-request.md\":\"EslJLAZ2\",\"reference_axe-response.md\":\"vVrJqda4\",\"reference_cache-configs.md\":\"KCPzVBW8\",\"reference_client-add-request.md\":\"D4iSx8J-\",\"reference_client-add-response.md\":\"CeNnk5gB\",\"reference_client-and-where.md\":\"ctKBm2xj\",\"reference_client-delete.md\":\"DU3menQe\",\"reference_client-first.md\":\"BgPt_Zl7\",\"reference_client-insert.md\":\"CoVbCsFs\",\"reference_client-or-where.md\":\"DPYCdyMG\",\"reference_client-paginate.md\":\"B7EadYVR\",\"reference_client-patch.md\":\"D4ROkvkR\",\"reference_client-resource.md\":\"guZ_kDze\",\"reference_client-set-config.md\":\"qjfnpmva\",\"reference_client-update.md\":\"D7Ue-_aY\",\"reference_client-where-between.md\":\"D2enRHzZ\",\"reference_client-where-in.md\":\"pob8s2Eg\",\"reference_client-where-like.md\":\"BvGWhO_N\",\"reference_client-where-null.md\":\"B_AD4swH\",\"reference_client-where.md\":\"CYsPWVLt\",\"reference_client-with.md\":\"B1Prn_7z\",\"reference_database-configs.md\":\"BAusUCdf\",\"reference_default-handlers.md\":\"cEKyX6Tc\",\"reference_elastic-search-configs.md\":\"DDpas-0v\",\"reference_error-codes.md\":\"D4NGNe71\",\"reference_handlers-all-handler.md\":\"BGD-tX2S\",\"reference_handlers-delete-handler.md\":\"OH8C8uTx\",\"reference_handlers-force-delete-handler.md\":\"DYycZ7-C\",\"reference_handlers-insert-handler.md\":\"C9BfCDX9\",\"reference_handlers-paginate-handler.md\":\"DtvSX-1n\",\"reference_handlers-patch-handler.md\":\"BuIqpP2H\",\"reference_handlers-search-handler.md\":\"BZKFDEfs\",\"reference_handlers-show-handler.md\":\"C3AR1ylO\",\"reference_handlers-update-handler.md\":\"BLQ_5tVJ\",\"reference_hooks-events-on-after-all.md\":\"CzaNgeTf\",\"reference_hooks-events-on-after-delete-query.md\":\"Cc55V1UM\",\"reference_hooks-events-on-after-delete.md\":\"CgEHIPlP\",\"reference_hooks-events-on-after-force-delete-query.md\":\"BzI6_GQQ\",\"reference_hooks-events-on-after-force-delete.md\":\"D51Ejfh1\",\"reference_hooks-events-on-after-insert.md\":\"j7FDwev5\",\"reference_hooks-events-on-after-paginate.md\":\"BxOSJD6M\",\"reference_hooks-events-on-after-patch-query.md\":\"CfqB6yJn\",\"reference_hooks-events-on-after-patch.md\":\"vnmKKVW6\",\"reference_hooks-events-on-after-search.md\":\"BS7qUNF9\",\"reference_hooks-events-on-after-show.md\":\"DO5sq-n7\",\"reference_hooks-events-on-after-update-query.md\":\"twQ5cUg4\",\"reference_hooks-events-on-after-update.md\":\"cNmIV1mo\",\"reference_hooks-events-on-before-all.md\":\"DWpL9YwP\",\"reference_hooks-events-on-before-delete-query.md\":\"1ugu4HMC\",\"reference_hooks-events-on-before-delete.md\":\"DpiKI3kd\",\"reference_hooks-events-on-before-force-delete-query.md\":\"CICDnuNS\",\"reference_hooks-events-on-before-force-delete.md\":\"Cu5k60Nh\",\"reference_hooks-events-on-before-insert.md\":\"DRPRQg1Z\",\"reference_hooks-events-on-before-paginate.md\":\"0F9Z1UYt\",\"reference_hooks-events-on-before-patch-query.md\":\"DVdcXbsb\",\"reference_hooks-events-on-before-patch.md\":\"DtS74Rn9\",\"reference_hooks-events-on-before-search.md\":\"zqbgRn3C\",\"reference_hooks-events-on-before-show.md\":\"DWcc409t\",\"reference_hooks-events-on-before-update-query.md\":\"C0wu0xIs\",\"reference_hooks-events-on-before-update.md\":\"D5ya7IGu\",\"reference_icontext.md\":\"C5LQOFZH\",\"reference_ioc.md\":\"B-boVLXn\",\"reference_model-cache.md\":\"CUC1Tgra\",\"reference_model-created-at-column.md\":\"D4fCTqkL\",\"reference_model-deleted-at-column.md\":\"DkRiQYs3\",\"reference_model-fillable.md\":\"kqrAJ_Rd\",\"reference_model-get-search-query.md\":\"QBJHEhMI\",\"reference_model-handlers.md\":\"BFSKQoFE\",\"reference_model-hiddens.md\":\"DVa6rV3h\",\"reference_model-ignore.md\":\"BGWSUTA9\",\"reference_model-limits.md\":\"DFfwwDuT\",\"reference_model-middlewares.md\":\"CLkDqhNA\",\"reference_model-primary-key.md\":\"CfEHO3ZO\",\"reference_model-search.md\":\"CjCtSrWR\",\"reference_model-table.md\":\"q-LAoqc0\",\"reference_model-transactions.md\":\"B3JxuTUi\",\"reference_model-updated-at-column.md\":\"DQTbejMm\",\"reference_model-validations.md\":\"U5eBUtQr\",\"reference_on-after-init.md\":\"BrWVKyny\",\"reference_on-before-init.md\":\"9p0nX5iv\",\"reference_pino-logger-configs.md\":\"DZg9Hcze\",\"reference_queries-fields.md\":\"BsrqI7OP\",\"reference_queries-page.md\":\"B8scHBrO\",\"reference_queries-per-page.md\":\"Bv6-VcZ2\",\"reference_queries-q.md\":\"Bw4tPu4f\",\"reference_queries-sort.md\":\"DdCLcVa_\",\"reference_queries-trashed.md\":\"DoYREmF6\",\"reference_queries-with.md\":\"0o6B0qh9\",\"reference_rate-limit-configs.md\":\"DdaVtdvW\",\"reference_redis-configs.md\":\"CUa65_nq\",\"reference_search-configs.md\":\"DJG8tIJH\",\"reference_version-configs.md\":\"CaFCFBNW\",\"rest-api.md\":\"DJWe4JfP\",\"upgrading_0.20.0.md\":\"CiwYK56w\",\"upgrading_0.30.0.md\":\"DIz8XJiq\",\"upgrading_v1.md\":\"BtHOX7TT\",\"upgrading_versioning-policy.md\":\"BjG5V7hV\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Axe API\",\"description\":\"The fastest way to create Rest API, by defining database models and relations.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":\"force-dark\",\"themeConfig\":{\"logo\":\"/axe.png\",\"editLink\":{\"pattern\":\"https://github.com/axe-api/docs/edit/master/docs/:path\",\"text\":\"Edit this page on GitHub\"},\"nav\":[{\"text\":\"Learn\",\"link\":\"/learn/quick-start\"},{\"text\":\"API Reference\",\"link\":\"/reference/api-configs\"},{\"text\":\"Blog\",\"link\":\"/blog/index\"},{\"text\":\"Upgrading\",\"items\":[{\"text\":\"Versioning Policy\",\"link\":\"/upgrading/versioning-policy\"},{\"text\":\"v1 (stable)\",\"link\":\"/upgrading/v1\"},{\"text\":\"v0.30\",\"link\":\"/upgrading/0.30.0.html\"},{\"text\":\"v0.20\",\"link\":\"/upgrading/0.20.0.html\"},{\"text\":\"Releases\",\"link\":\"https://github.com/axe-api/axe-api/releases\"},{\"text\":\"Changelog\",\"link\":\"https://github.com/axe-api/axe-api/blob/master/CHANGELOG.md\"}]},{\"text\":\"Ecosystem\",\"items\":[{\"text\":\"Support\",\"link\":\"/ecosystem/support\"},{\"text\":\"FAQ\",\"link\":\"/ecosystem/faq\"},{\"text\":\"Team\",\"link\":\"/ecosystem/team\"},{\"text\":\"CLI\",\"link\":\"https://github.com/axe-api/axe-magic\"},{\"text\":\"SonarCloud\",\"link\":\"https://sonarcloud.io/dashboard?id=axe-api_axe-api\"}]},{\"text\":\"v1\",\"items\":[{\"text\":\"v1 (stable)\",\"link\":\"https://axe-api.com\"},{\"text\":\"v0.30\",\"link\":\"https://legacy.axe-api.com\"}]},{\"text\":\"GitHub\",\"link\":\"https://github.com/axe-api/axe-api\"}],\"sidebar\":{\"/learn/\":[{\"text\":\"Getting Started\",\"collapsed\":false,\"items\":[{\"text\":\"Quick start\",\"link\":\"/learn/quick-start\"},{\"text\":\"Tutorial: Bookstore API\",\"link\":\"/learn/bookstore-api\"}]},{\"text\":\"Fundamentals\",\"collapsed\":true,\"items\":[{\"text\":\"What does a Model mean?\",\"link\":\"/learn/models\"},{\"text\":\"Understanding the routing\",\"link\":\"/learn/routing\"},{\"text\":\"Version management\",\"link\":\"/learn/version-management\"},{\"text\":\"Validate your data\",\"link\":\"/learn/validations\"}]},{\"text\":\"Gains\",\"collapsed\":true,\"items\":[{\"text\":\"Auto-created documentation\",\"link\":\"/learn/documentation\"},{\"text\":\"Querying data\",\"link\":\"/learn/querying-data\"},{\"text\":\"Related data queries\",\"link\":\"/learn/related-data-queries\"},{\"text\":\"Auto-caching\",\"link\":\"/learn/caching\"},{\"text\":\"Full-text search\",\"link\":\"/learn/full-text-search\"},{\"text\":\"JavaScript Client\",\"link\":\"/learn/javascript-client-axe-api-client\"},{\"text\":\"How DB Analyzer works?\",\"link\":\"/learn/db-analyzer\"}]},{\"text\":\"Application Logic\",\"collapsed\":true,\"items\":[{\"text\":\"Getting started\",\"link\":\"/learn/application-logic\"},{\"text\":\"Request-Response cycle\",\"link\":\"/learn/request-response-cycle\"},{\"text\":\"Middlewares\",\"link\":\"/learn/middlewares\"},{\"text\":\"Hooks & Events\",\"link\":\"/learn/hooks-and-events\"},{\"text\":\"Serializers\",\"link\":\"/learn/serializers\"}]},{\"text\":\"Advanced\",\"collapsed\":true,\"items\":[{\"text\":\"Configurations\",\"link\":\"/learn/configurations\"},{\"text\":\"Internationalization\",\"link\":\"/learn/i18n\"},{\"text\":\"Error handling\",\"link\":\"/learn/error-handling\"},{\"text\":\"Database transactions\",\"link\":\"/learn/database-transactions\"}]},{\"text\":\"How to?\",\"collapsed\":true,\"items\":[{\"text\":\"Migrate database\",\"link\":\"/learn/database-migrations\"},{\"text\":\"File uploading\",\"link\":\"/learn/file-uploading\"},{\"text\":\"Serving static files\",\"link\":\"/learn/serving-static-files\"},{\"text\":\"Authentication\",\"link\":\"/learn/authentication\"},{\"text\":\"Rate limiting\",\"link\":\"/learn/rate-limiting\"},{\"text\":\"Testing\",\"link\":\"/learn/testing\"},{\"text\":\"Deployment\",\"link\":\"/learn/deployment\"}]},{\"text\":\"Contribution\",\"collapsed\":true,\"items\":[{\"text\":\"Preparation\",\"link\":\"/learn/contribution\"},{\"text\":\"Development Kit\",\"link\":\"/learn/development-kit\"},{\"text\":\"Databases\",\"link\":\"/learn/dev-kit-databases\"},{\"text\":\"Tests\",\"link\":\"/learn/contribution-tests\"}]}],\"/reference/\":[{\"text\":\"Configs\",\"collapsed\":false,\"items\":[{\"text\":\"API configs\",\"link\":\"/reference/api-configs\"},{\"text\":\"Pino (logger) configs\",\"link\":\"/reference/pino-logger-configs\"},{\"text\":\"Rate limit configs\",\"link\":\"/reference/rate-limit-configs\"},{\"text\":\"Database configs\",\"link\":\"/reference/database-configs\"},{\"text\":\"Cache configs\",\"link\":\"/reference/cache-configs\"},{\"text\":\"Redis configs\",\"link\":\"/reference/redis-configs\"},{\"text\":\"Elasticsearch configs\",\"link\":\"/reference/elastic-search-configs\"},{\"text\":\"Search configs\",\"link\":\"/reference/search-configs\"},{\"text\":\"Version configs\",\"link\":\"/reference/version-configs\"}]},{\"text\":\"Initialization\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInit()\",\"link\":\"/reference/on-before-init\"},{\"text\":\"onAfterInit()\",\"link\":\"/reference/on-after-init\"}]},{\"text\":\"Axe API\",\"collapsed\":true,\"items\":[{\"text\":\"App\",\"link\":\"/reference/app\"},{\"text\":\"IContext\",\"link\":\"/reference/icontext\"},{\"text\":\"AxeRequest\",\"link\":\"/reference/axe-request\"},{\"text\":\"AxeResponse\",\"link\":\"/reference/axe-response\"},{\"text\":\"IoC\",\"link\":\"/reference/ioc\"},{\"text\":\"ApiError\",\"link\":\"/reference/api-error\"},{\"text\":\"Error Codes\",\"link\":\"/errors\"}]},{\"text\":\"Models\",\"collapsed\":true,\"items\":[{\"text\":\"table()\",\"link\":\"/reference/model-table\"},{\"text\":\"primaryKey()\",\"link\":\"/reference/model-primary-key\"},{\"text\":\"fillable()\",\"link\":\"/reference/model-fillable\"},{\"text\":\"validations()\",\"link\":\"/reference/model-validations\"},{\"text\":\"hiddens()\",\"link\":\"/reference/model-hiddens\"},{\"text\":\"createdAtColumn()\",\"link\":\"/reference/model-created-at-column\"},{\"text\":\"updatedAtColumn()\",\"link\":\"/reference/model-updated-at-column\"},{\"text\":\"deletedAtColumn()\",\"link\":\"/reference/model-deleted-at-column\"},{\"text\":\"handlers()\",\"link\":\"/reference/model-handlers\"},{\"text\":\"middlewares()\",\"link\":\"/reference/model-middlewares\"},{\"text\":\"transactions()\",\"link\":\"/reference/model-transactions\"},{\"text\":\"limits()\",\"link\":\"/reference/model-limits\"},{\"text\":\"cache()\",\"link\":\"/reference/model-cache\"},{\"text\":\"search()\",\"link\":\"/reference/model-search\"},{\"text\":\"getSearchQuery()\",\"link\":\"/reference/model-get-search-query\"},{\"text\":\"ignore()\",\"link\":\"/reference/model-ignore\"}]},{\"text\":\"Handlers\",\"collapsed\":true,\"items\":[{\"text\":\"Defaults\",\"link\":\"/reference/default-handlers\"},{\"text\":\"INSERT\",\"link\":\"/reference/handlers-insert-handler\"},{\"text\":\"PAGINATE\",\"link\":\"/reference/handlers-paginate-handler\"},{\"text\":\"SHOW\",\"link\":\"/reference/handlers-show-handler\"},{\"text\":\"UPDATE\",\"link\":\"/reference/handlers-update-handler\"},{\"text\":\"DELETE\",\"link\":\"/reference/handlers-delete-handler\"},{\"text\":\"FORCE_DELETE\",\"link\":\"/reference/handlers-force-delete-handler\"},{\"text\":\"PATCH\",\"link\":\"/reference/handlers-patch-handler\"},{\"text\":\"ALL\",\"link\":\"/reference/handlers-all-handler\"},{\"text\":\"SEARCH\",\"link\":\"/reference/handlers-search-handler\"}]},{\"text\":\"Queries\",\"collapsed\":true,\"items\":[{\"text\":\"fields\",\"link\":\"/reference/queries-fields\"},{\"text\":\"sort\",\"link\":\"/reference/queries-sort\"},{\"text\":\"page\",\"link\":\"/reference/queries-page\"},{\"text\":\"per_page\",\"link\":\"/reference/queries-per-page\"},{\"text\":\"trashed\",\"link\":\"/reference/queries-trashed\"},{\"text\":\"q\",\"link\":\"/reference/queries-q\"},{\"text\":\"with\",\"link\":\"/reference/queries-with\"}]},{\"text\":\"Hooks & Events\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInsert()\",\"link\":\"/reference/hooks-events-on-before-insert\"},{\"text\":\"onBeforeUpdateQuery()\",\"link\":\"/reference/hooks-events-on-before-update-query\"},{\"text\":\"onBeforeUpdate()\",\"link\":\"/reference/hooks-events-on-before-update\"},{\"text\":\"onBeforePatchQuery()\",\"link\":\"/reference/hooks-events-on-before-patch-query\"},{\"text\":\"onBeforePatch()\",\"link\":\"/reference/hooks-events-on-before-patch\"},{\"text\":\"onBeforeDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-delete-query\"},{\"text\":\"onBeforeDelete()\",\"link\":\"/reference/hooks-events-on-before-delete\"},{\"text\":\"onBeforeForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-force-delete-query\"},{\"text\":\"onBeforeForceDelete()\",\"link\":\"/reference/hooks-events-on-before-force-delete\"},{\"text\":\"onBeforePaginate()\",\"link\":\"/reference/hooks-events-on-before-paginate\"},{\"text\":\"onBeforeAll()\",\"link\":\"/reference/hooks-events-on-before-all\"},{\"text\":\"onBeforeSearch()\",\"link\":\"/reference/hooks-events-on-before-search\"},{\"text\":\"onBeforeShow()\",\"link\":\"/reference/hooks-events-on-before-show\"},{\"text\":\"onAfterInsert()\",\"link\":\"/reference/hooks-events-on-after-insert\"},{\"text\":\"onAfterUpdateQuery()\",\"link\":\"/reference/hooks-events-on-after-update-query\"},{\"text\":\"onAfterUpdate()\",\"link\":\"/reference/hooks-events-on-after-update\"},{\"text\":\"onAfterPatchQuery()\",\"link\":\"/reference/hooks-events-on-after-patch-query\"},{\"text\":\"onAfterPatch()\",\"link\":\"/reference/hooks-events-on-after-patch\"},{\"text\":\"onAfterDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-delete-query\"},{\"text\":\"onAfterDelete()\",\"link\":\"/reference/hooks-events-on-after-delete\"},{\"text\":\"onAfterForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-force-delete-query\"},{\"text\":\"onAfterForceDelete()\",\"link\":\"/reference/hooks-events-on-after-force-delete\"},{\"text\":\"onAfterPaginate()\",\"link\":\"/reference/hooks-events-on-after-paginate\"},{\"text\":\"onAfterAll()\",\"link\":\"/reference/hooks-events-on-after-all\"},{\"text\":\"onAfterSearch()\",\"link\":\"/reference/hooks-events-on-after-search\"},{\"text\":\"onAfterShow()\",\"link\":\"/reference/hooks-events-on-after-show\"}]},{\"text\":\"Axe API Client\",\"collapsed\":true,\"items\":[{\"text\":\"setConfig()\",\"link\":\"/reference/client-set-config\"},{\"text\":\"addRequest()\",\"link\":\"/reference/client-add-request\"},{\"text\":\"addResponse()\",\"link\":\"/reference/client-add-response\"},{\"text\":\"first()\",\"link\":\"/reference/client-first\"},{\"text\":\"resource()\",\"link\":\"/reference/client-resource\"},{\"text\":\"insert()\",\"link\":\"/reference/client-insert\"},{\"text\":\"update()\",\"link\":\"/reference/client-update\"},{\"text\":\"patch()\",\"link\":\"/reference/client-patch\"},{\"text\":\"delete()\",\"link\":\"/reference/client-delete\"},{\"text\":\"paginate()\",\"link\":\"/reference/client-paginate\"},{\"text\":\"with()\",\"link\":\"/reference/client-with\"},{\"text\":\"where()\",\"link\":\"/reference/client-where\"},{\"text\":\"orWhere()\",\"link\":\"/reference/client-or-where\"},{\"text\":\"andWhere()\",\"link\":\"/reference/client-and-where\"},{\"text\":\"whereLike()\",\"link\":\"/reference/client-where-like\"},{\"text\":\"whereIn()\",\"link\":\"/reference/client-where-in\"},{\"text\":\"whereBetween()\",\"link\":\"/reference/client-where-between\"},{\"text\":\"whereNull()\",\"link\":\"/reference/client-where-null\"}]}],\"/errors\":[{\"text\":\"Configs\",\"collapsed\":false,\"items\":[{\"text\":\"API configs\",\"link\":\"/reference/api-configs\"},{\"text\":\"Pino (logger) configs\",\"link\":\"/reference/pino-logger-configs\"},{\"text\":\"Rate limit configs\",\"link\":\"/reference/rate-limit-configs\"},{\"text\":\"Database configs\",\"link\":\"/reference/database-configs\"},{\"text\":\"Cache configs\",\"link\":\"/reference/cache-configs\"},{\"text\":\"Redis configs\",\"link\":\"/reference/redis-configs\"},{\"text\":\"Elasticsearch configs\",\"link\":\"/reference/elastic-search-configs\"},{\"text\":\"Search configs\",\"link\":\"/reference/search-configs\"},{\"text\":\"Version configs\",\"link\":\"/reference/version-configs\"}]},{\"text\":\"Initialization\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInit()\",\"link\":\"/reference/on-before-init\"},{\"text\":\"onAfterInit()\",\"link\":\"/reference/on-after-init\"}]},{\"text\":\"Axe API\",\"collapsed\":true,\"items\":[{\"text\":\"App\",\"link\":\"/reference/app\"},{\"text\":\"IContext\",\"link\":\"/reference/icontext\"},{\"text\":\"AxeRequest\",\"link\":\"/reference/axe-request\"},{\"text\":\"AxeResponse\",\"link\":\"/reference/axe-response\"},{\"text\":\"IoC\",\"link\":\"/reference/ioc\"},{\"text\":\"ApiError\",\"link\":\"/reference/api-error\"},{\"text\":\"Error Codes\",\"link\":\"/errors\"}]},{\"text\":\"Models\",\"collapsed\":true,\"items\":[{\"text\":\"table()\",\"link\":\"/reference/model-table\"},{\"text\":\"primaryKey()\",\"link\":\"/reference/model-primary-key\"},{\"text\":\"fillable()\",\"link\":\"/reference/model-fillable\"},{\"text\":\"validations()\",\"link\":\"/reference/model-validations\"},{\"text\":\"hiddens()\",\"link\":\"/reference/model-hiddens\"},{\"text\":\"createdAtColumn()\",\"link\":\"/reference/model-created-at-column\"},{\"text\":\"updatedAtColumn()\",\"link\":\"/reference/model-updated-at-column\"},{\"text\":\"deletedAtColumn()\",\"link\":\"/reference/model-deleted-at-column\"},{\"text\":\"handlers()\",\"link\":\"/reference/model-handlers\"},{\"text\":\"middlewares()\",\"link\":\"/reference/model-middlewares\"},{\"text\":\"transactions()\",\"link\":\"/reference/model-transactions\"},{\"text\":\"limits()\",\"link\":\"/reference/model-limits\"},{\"text\":\"cache()\",\"link\":\"/reference/model-cache\"},{\"text\":\"search()\",\"link\":\"/reference/model-search\"},{\"text\":\"getSearchQuery()\",\"link\":\"/reference/model-get-search-query\"},{\"text\":\"ignore()\",\"link\":\"/reference/model-ignore\"}]},{\"text\":\"Handlers\",\"collapsed\":true,\"items\":[{\"text\":\"Defaults\",\"link\":\"/reference/default-handlers\"},{\"text\":\"INSERT\",\"link\":\"/reference/handlers-insert-handler\"},{\"text\":\"PAGINATE\",\"link\":\"/reference/handlers-paginate-handler\"},{\"text\":\"SHOW\",\"link\":\"/reference/handlers-show-handler\"},{\"text\":\"UPDATE\",\"link\":\"/reference/handlers-update-handler\"},{\"text\":\"DELETE\",\"link\":\"/reference/handlers-delete-handler\"},{\"text\":\"FORCE_DELETE\",\"link\":\"/reference/handlers-force-delete-handler\"},{\"text\":\"PATCH\",\"link\":\"/reference/handlers-patch-handler\"},{\"text\":\"ALL\",\"link\":\"/reference/handlers-all-handler\"},{\"text\":\"SEARCH\",\"link\":\"/reference/handlers-search-handler\"}]},{\"text\":\"Queries\",\"collapsed\":true,\"items\":[{\"text\":\"fields\",\"link\":\"/reference/queries-fields\"},{\"text\":\"sort\",\"link\":\"/reference/queries-sort\"},{\"text\":\"page\",\"link\":\"/reference/queries-page\"},{\"text\":\"per_page\",\"link\":\"/reference/queries-per-page\"},{\"text\":\"trashed\",\"link\":\"/reference/queries-trashed\"},{\"text\":\"q\",\"link\":\"/reference/queries-q\"},{\"text\":\"with\",\"link\":\"/reference/queries-with\"}]},{\"text\":\"Hooks & Events\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInsert()\",\"link\":\"/reference/hooks-events-on-before-insert\"},{\"text\":\"onBeforeUpdateQuery()\",\"link\":\"/reference/hooks-events-on-before-update-query\"},{\"text\":\"onBeforeUpdate()\",\"link\":\"/reference/hooks-events-on-before-update\"},{\"text\":\"onBeforePatchQuery()\",\"link\":\"/reference/hooks-events-on-before-patch-query\"},{\"text\":\"onBeforePatch()\",\"link\":\"/reference/hooks-events-on-before-patch\"},{\"text\":\"onBeforeDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-delete-query\"},{\"text\":\"onBeforeDelete()\",\"link\":\"/reference/hooks-events-on-before-delete\"},{\"text\":\"onBeforeForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-force-delete-query\"},{\"text\":\"onBeforeForceDelete()\",\"link\":\"/reference/hooks-events-on-before-force-delete\"},{\"text\":\"onBeforePaginate()\",\"link\":\"/reference/hooks-events-on-before-paginate\"},{\"text\":\"onBeforeAll()\",\"link\":\"/reference/hooks-events-on-before-all\"},{\"text\":\"onBeforeSearch()\",\"link\":\"/reference/hooks-events-on-before-search\"},{\"text\":\"onBeforeShow()\",\"link\":\"/reference/hooks-events-on-before-show\"},{\"text\":\"onAfterInsert()\",\"link\":\"/reference/hooks-events-on-after-insert\"},{\"text\":\"onAfterUpdateQuery()\",\"link\":\"/reference/hooks-events-on-after-update-query\"},{\"text\":\"onAfterUpdate()\",\"link\":\"/reference/hooks-events-on-after-update\"},{\"text\":\"onAfterPatchQuery()\",\"link\":\"/reference/hooks-events-on-after-patch-query\"},{\"text\":\"onAfterPatch()\",\"link\":\"/reference/hooks-events-on-after-patch\"},{\"text\":\"onAfterDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-delete-query\"},{\"text\":\"onAfterDelete()\",\"link\":\"/reference/hooks-events-on-after-delete\"},{\"text\":\"onAfterForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-force-delete-query\"},{\"text\":\"onAfterForceDelete()\",\"link\":\"/reference/hooks-events-on-after-force-delete\"},{\"text\":\"onAfterPaginate()\",\"link\":\"/reference/hooks-events-on-after-paginate\"},{\"text\":\"onAfterAll()\",\"link\":\"/reference/hooks-events-on-after-all\"},{\"text\":\"onAfterSearch()\",\"link\":\"/reference/hooks-events-on-after-search\"},{\"text\":\"onAfterShow()\",\"link\":\"/reference/hooks-events-on-after-show\"}]},{\"text\":\"Axe API Client\",\"collapsed\":true,\"items\":[{\"text\":\"setConfig()\",\"link\":\"/reference/client-set-config\"},{\"text\":\"addRequest()\",\"link\":\"/reference/client-add-request\"},{\"text\":\"addResponse()\",\"link\":\"/reference/client-add-response\"},{\"text\":\"first()\",\"link\":\"/reference/client-first\"},{\"text\":\"resource()\",\"link\":\"/reference/client-resource\"},{\"text\":\"insert()\",\"link\":\"/reference/client-insert\"},{\"text\":\"update()\",\"link\":\"/reference/client-update\"},{\"text\":\"patch()\",\"link\":\"/reference/client-patch\"},{\"text\":\"delete()\",\"link\":\"/reference/client-delete\"},{\"text\":\"paginate()\",\"link\":\"/reference/client-paginate\"},{\"text\":\"with()\",\"link\":\"/reference/client-with\"},{\"text\":\"where()\",\"link\":\"/reference/client-where\"},{\"text\":\"orWhere()\",\"link\":\"/reference/client-or-where\"},{\"text\":\"andWhere()\",\"link\":\"/reference/client-and-where\"},{\"text\":\"whereLike()\",\"link\":\"/reference/client-where-like\"},{\"text\":\"whereIn()\",\"link\":\"/reference/client-where-in\"},{\"text\":\"whereBetween()\",\"link\":\"/reference/client-where-between\"},{\"text\":\"whereNull()\",\"link\":\"/reference/client-where-null\"}]}],\"/upgrading/\":[{\"text\":\"Versioning Policy\",\"link\":\"/upgrading/versioning-policy\"},{\"text\":\"Upgrading to v1\",\"link\":\"/upgrading/v1\"},{\"text\":\"Upgrading to 0.30.0\",\"link\":\"/upgrading/0.30.0.html\"},{\"text\":\"Upgrading to 0.20.0\",\"link\":\"/upgrading/0.20.0.html\"}],\"/ecosystem/\":[{\"text\":\"Support\",\"link\":\"/ecosystem/support\"},{\"text\":\"FAQ\",\"link\":\"/ecosystem/faq\"},{\"text\":\"Team\",\"link\":\"/ecosystem/team\"},{\"text\":\"CLI\",\"link\":\"https://github.com/axe-api/axe-magic\"},{\"text\":\"SonarCloud\",\"link\":\"https://sonarcloud.io/dashboard?id=axe-api_axe-api\"}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/axe-api/axe-api\"},{\"icon\":\"twitter\",\"link\":\"https://twitter.com/axeapi\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2020-present\"},\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
</body>
</html>