UNPKG

37.8 kBHTMLView Raw
1<!doctype html>
2<html class="default no-js">
3<head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <title>@breautek/storm</title>
7 <meta name="description" content="Documentation for @breautek/storm">
8 <meta name="viewport" content="width=device-width, initial-scale=1">
9 <link rel="stylesheet" href="assets/css/main.css">
10</head>
11<body>
12<header>
13 <div class="tsd-page-toolbar">
14 <div class="container">
15 <div class="table-wrap">
16 <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
17 <div class="field">
18 <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19 <input id="tsd-search-field" type="text" />
20 </div>
21 <ul class="results">
22 <li class="state loading">Preparing search index...</li>
23 <li class="state failure">The search index is not available</li>
24 </ul>
25 <a href="index.html" class="title">@breautek/storm</a>
26 </div>
27 <div class="table-cell" id="tsd-widgets">
28 <div id="tsd-filter">
29 <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30 <div class="tsd-filter-group">
31 <div class="tsd-select" id="tsd-filter-visibility">
32 <span class="tsd-select-label">All</span>
33 <ul class="tsd-select-list">
34 <li data-value="public">Public</li>
35 <li data-value="protected">Public/Protected</li>
36 <li data-value="private" class="selected">All</li>
37 </ul>
38 </div>
39 <input type="checkbox" id="tsd-filter-inherited" checked />
40 <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41 <input type="checkbox" id="tsd-filter-externals" checked />
42 <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43 </div>
44 </div>
45 <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
46 </div>
47 </div>
48 </div>
49 </div>
50 <div class="tsd-page-title">
51 <div class="container">
52 <ul class="tsd-breadcrumb">
53 <li>
54 <a href="globals.html">Globals</a>
55 </li>
56 </ul>
57 <h1>@breautek/storm</h1>
58 </div>
59 </div>
60</header>
61<div class="container container-main">
62 <div class="row">
63 <div class="col-8 col-content">
64 <section class="tsd-panel-group tsd-index-group">
65 <h2>Index</h2>
66 <section class="tsd-panel tsd-index-panel">
67 <div class="tsd-index-content">
68 <section class="tsd-index-section ">
69 <h3>Enumerations</h3>
70 <ul class="tsd-index-list">
71 <li class="tsd-kind-enum"><a href="enums/applicationevent.html" class="tsd-kind-icon">Application<wbr>Event</a></li>
72 <li class="tsd-kind-enum"><a href="enums/errorcode.html" class="tsd-kind-icon">Error<wbr>Code</a></li>
73 <li class="tsd-kind-enum"><a href="enums/exitcode.html" class="tsd-kind-icon">Exit<wbr>Code</a></li>
74 <li class="tsd-kind-enum"><a href="enums/httpmethod.html" class="tsd-kind-icon">HTTPMethod</a></li>
75 <li class="tsd-kind-enum"><a href="enums/logevent.html" class="tsd-kind-icon">Log<wbr>Event</a></li>
76 <li class="tsd-kind-enum"><a href="enums/logseverity.html" class="tsd-kind-icon">Log<wbr>Severity</a></li>
77 <li class="tsd-kind-enum"><a href="enums/statuscode.html" class="tsd-kind-icon">Status<wbr>Code</a></li>
78 </ul>
79 </section>
80 <section class="tsd-index-section ">
81 <h3>Classes</h3>
82 <ul class="tsd-index-list">
83 <li class="tsd-kind-class"><a href="classes/application.html" class="tsd-kind-icon">Application</a></li>
84 <li class="tsd-kind-class"><a href="classes/authenticationmiddleware.html" class="tsd-kind-icon">Authentication<wbr>Middleware</a></li>
85 <li class="tsd-kind-class"><a href="classes/backendauthenticationmiddleware.html" class="tsd-kind-icon">Backend<wbr>Authentication<wbr>Middleware</a></li>
86 <li class="tsd-kind-class"><a href="classes/corsmiddleware.html" class="tsd-kind-icon">CORSMiddleware</a></li>
87 <li class="tsd-kind-class"><a href="classes/commitquery.html" class="tsd-kind-icon">Commit<wbr>Query</a></li>
88 <li class="tsd-kind-class"><a href="classes/configloader.html" class="tsd-kind-icon">Config<wbr>Loader</a></li>
89 <li class="tsd-kind-class"><a href="classes/database.html" class="tsd-kind-icon">Database</a></li>
90 <li class="tsd-kind-class"><a href="classes/databaseconnection.html" class="tsd-kind-icon">Database<wbr>Connection</a></li>
91 <li class="tsd-kind-class"><a href="classes/databasequeryerror.html" class="tsd-kind-icon">Database<wbr>Query<wbr>Error</a></li>
92 <li class="tsd-kind-class"><a href="classes/diskspaceerror.html" class="tsd-kind-icon">Disk<wbr>Space<wbr>Error</a></li>
93 <li class="tsd-kind-class"><a href="classes/dumpstream.html" class="tsd-kind-icon">Dump<wbr>Stream</a></li>
94 <li class="tsd-kind-class"><a href="classes/duplicateentryerror.html" class="tsd-kind-icon">Duplicate<wbr>Entry<wbr>Error</a></li>
95 <li class="tsd-kind-class"><a href="classes/entitynotfounderror.html" class="tsd-kind-icon">Entity<wbr>Not<wbr>Found<wbr>Error</a></li>
96 <li class="tsd-kind-class"><a href="classes/expiredtokenerror.html" class="tsd-kind-icon">Expired<wbr>Token<wbr>Error</a></li>
97 <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/handler.html" class="tsd-kind-icon">Handler</a></li>
98 <li class="tsd-kind-class"><a href="classes/internalerror.html" class="tsd-kind-icon">Internal<wbr>Error</a></li>
99 <li class="tsd-kind-class"><a href="classes/invalidcredentialserror.html" class="tsd-kind-icon">Invalid<wbr>Credentials<wbr>Error</a></li>
100 <li class="tsd-kind-class"><a href="classes/invalidvalueerror.html" class="tsd-kind-icon">Invalid<wbr>Value<wbr>Error</a></li>
101 <li class="tsd-kind-class"><a href="classes/jwtverifyoptionsparser.html" class="tsd-kind-icon">JWTVerify<wbr>Options<wbr>Parser</a></li>
102 <li class="tsd-kind-class"><a href="classes/logger.html" class="tsd-kind-icon">Logger</a></li>
103 <li class="tsd-kind-class"><a href="classes/loggermiddleware.html" class="tsd-kind-icon">Logger<wbr>Middleware</a></li>
104 <li class="tsd-kind-class"><a href="classes/manageddatabaseconnection.html" class="tsd-kind-icon">Managed<wbr>Database<wbr>Connection</a></li>
105 <li class="tsd-kind-class"><a href="classes/middleware.html" class="tsd-kind-icon">Middleware</a></li>
106 <li class="tsd-kind-class"><a href="classes/missingparametererror.html" class="tsd-kind-icon">Missing<wbr>Parameter<wbr>Error</a></li>
107 <li class="tsd-kind-class"><a href="classes/mysqlconnection.html" class="tsd-kind-icon">MySQLConnection</a></li>
108 <li class="tsd-kind-class"><a href="classes/mysqldatabase.html" class="tsd-kind-icon">MySQLDatabase</a></li>
109 <li class="tsd-kind-class"><a href="classes/query.html" class="tsd-kind-icon">Query</a></li>
110 <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/request.html" class="tsd-kind-icon">Request</a></li>
111 <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/response.html" class="tsd-kind-icon">Response</a></li>
112 <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/responsedata.html" class="tsd-kind-icon">Response<wbr>Data</a></li>
113 <li class="tsd-kind-class"><a href="classes/rollbackquery.html" class="tsd-kind-icon">Rollback<wbr>Query</a></li>
114 <li class="tsd-kind-class"><a href="classes/serviceprovider.html" class="tsd-kind-icon">Service<wbr>Provider</a></li>
115 <li class="tsd-kind-class"><a href="classes/serviceresponse.html" class="tsd-kind-icon">Service<wbr>Response</a></li>
116 <li class="tsd-kind-class"><a href="classes/starttransactionquery.html" class="tsd-kind-icon">Start<wbr>Transaction<wbr>Query</a></li>
117 <li class="tsd-kind-class"><a href="classes/stormerror.html" class="tsd-kind-icon">Storm<wbr>Error</a></li>
118 <li class="tsd-kind-class"><a href="classes/token.html" class="tsd-kind-icon">Token</a></li>
119 <li class="tsd-kind-class"><a href="classes/tokenmanager.html" class="tsd-kind-icon">Token<wbr>Manager</a></li>
120 <li class="tsd-kind-class"><a href="classes/unauthorizedaccesserror.html" class="tsd-kind-icon">Unauthorized<wbr>Access<wbr>Error</a></li>
121 </ul>
122 </section>
123 <section class="tsd-index-section ">
124 <h3>Interfaces</h3>
125 <ul class="tsd-index-list">
126 <li class="tsd-kind-interface"><a href="interfaces/iadditionalerrordetails.html" class="tsd-kind-icon">IAdditional<wbr>Error<wbr>Details</a></li>
127 <li class="tsd-kind-interface"><a href="interfaces/iconfig.html" class="tsd-kind-icon">IConfig</a></li>
128 <li class="tsd-kind-interface"><a href="interfaces/idatabaseconnection.html" class="tsd-kind-icon">IDatabase<wbr>Connection</a></li>
129 <li class="tsd-kind-interface"><a href="interfaces/iduplicateentryerroroptions.html" class="tsd-kind-icon">IDuplicate<wbr>Entry<wbr>Error<wbr>Options</a></li>
130 <li class="tsd-kind-interface"><a href="interfaces/ierrorresponse.html" class="tsd-kind-icon">IError<wbr>Response</a></li>
131 <li class="tsd-kind-interface"><a href="interfaces/iformdata.html" class="tsd-kind-icon">IForm<wbr>Data</a></li>
132 <li class="tsd-kind-interface"><a href="interfaces/ihandler.html" class="tsd-kind-icon">IHandler</a></li>
133 <li class="tsd-kind-interface"><a href="interfaces/iheaderkeyvaluepair.html" class="tsd-kind-icon">IHeader<wbr>Key<wbr>Value<wbr>Pair</a></li>
134 <li class="tsd-kind-interface"><a href="interfaces/ijwtverifyoptions.html" class="tsd-kind-icon">IJWTVerify<wbr>Options</a></li>
135 <li class="tsd-kind-interface"><a href="interfaces/ilogevent.html" class="tsd-kind-icon">ILog<wbr>Event</a></li>
136 <li class="tsd-kind-interface"><a href="interfaces/iparametermap.html" class="tsd-kind-icon">IParameter<wbr>Map</a></li>
137 <li class="tsd-kind-interface"><a href="interfaces/iqueryparameters.html" class="tsd-kind-icon">IQuery<wbr>Parameters</a></li>
138 <li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/irequestresponse.html" class="tsd-kind-icon">IRequest<wbr>Response</a></li>
139 <li class="tsd-kind-interface"><a href="interfaces/iserviceheaders.html" class="tsd-kind-icon">IService<wbr>Headers</a></li>
140 </ul>
141 </section>
142 <section class="tsd-index-section ">
143 <h3>Type aliases</h3>
144 <ul class="tsd-index-list">
145 <li class="tsd-kind-type-alias"><a href="globals.html#sendabledata" class="tsd-kind-icon">Sendable<wbr>Data</a></li>
146 </ul>
147 </section>
148 <section class="tsd-index-section ">
149 <h3>Variables</h3>
150 <ul class="tsd-index-list">
151 <li class="tsd-kind-variable"><a href="globals.html#commander" class="tsd-kind-icon">Commander</a></li>
152 <li class="tsd-kind-variable"><a href="globals.html#default_high_watermark" class="tsd-kind-icon">DEFAULT_<wbr>HIGH_<wbr>WATERMARK</a></li>
153 <li class="tsd-kind-variable"><a href="globals.html#default_log_level" class="tsd-kind-icon">DEFAULT_<wbr>LOG_<wbr>LEVEL</a></li>
154 <li class="tsd-kind-variable"><a href="globals.html#default_query_timeout" class="tsd-kind-icon">DEFAULT_<wbr>QUERY_<wbr>TIMEOUT</a></li>
155 <li class="tsd-kind-variable"><a href="globals.html#linger_warning" class="tsd-kind-icon">LINGER_<wbr>WARNING</a></li>
156 <li class="tsd-kind-variable"><a href="globals.html#master_name" class="tsd-kind-icon">MASTER_<wbr>NAME</a></li>
157 <li class="tsd-kind-variable"><a href="globals.html#no_data" class="tsd-kind-icon">NO_<wbr>DATA</a></li>
158 <li class="tsd-kind-variable"><a href="globals.html#commitquery" class="tsd-kind-icon">commit<wbr>Query</a></li>
159 <li class="tsd-kind-variable"><a href="globals.html#genericlogger" class="tsd-kind-icon">generic<wbr>Logger</a></li>
160 <li class="tsd-kind-variable"><a href="globals.html#instance" class="tsd-kind-icon">instance</a></li>
161 <li class="tsd-kind-variable"><a href="globals.html#rollbackquery" class="tsd-kind-icon">rollback<wbr>Query</a></li>
162 <li class="tsd-kind-variable"><a href="globals.html#starttransactionquery" class="tsd-kind-icon">start<wbr>Transaction<wbr>Query</a></li>
163 </ul>
164 </section>
165 <section class="tsd-index-section ">
166 <h3>Functions</h3>
167 <ul class="tsd-index-list">
168 <li class="tsd-kind-function"><a href="globals.html#getapplicationlogger" class="tsd-kind-icon">get<wbr>Application<wbr>Logger</a></li>
169 <li class="tsd-kind-function"><a href="globals.html#getinstance" class="tsd-kind-icon">get<wbr>Instance</a></li>
170 <li class="tsd-kind-function"><a href="globals.html#setinstance" class="tsd-kind-icon">set<wbr>Instance</a></li>
171 </ul>
172 </section>
173 </div>
174 </section>
175 </section>
176 <section class="tsd-panel-group tsd-member-group ">
177 <h2>Type aliases</h2>
178 <section class="tsd-panel tsd-member tsd-kind-type-alias">
179 <a name="sendabledata" class="tsd-anchor"></a>
180 <h3>Sendable<wbr>Data</h3>
181 <div class="tsd-signature tsd-kind-icon">Sendable<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="classes/responsedata.html" class="tsd-signature-type">ResponseData</a><span class="tsd-signature-symbol"> | </span><a href="classes/stormerror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><a href="interfaces/ierrorresponse.html" class="tsd-signature-type">IErrorResponse</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span></div>
182 <aside class="tsd-sources">
183 <ul>
184 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/Response.ts#L23">src/Response.ts:23</a></li>
185 </ul>
186 </aside>
187 </section>
188 </section>
189 <section class="tsd-panel-group tsd-member-group ">
190 <h2>Variables</h2>
191 <section class="tsd-panel tsd-member tsd-kind-variable">
192 <a name="commander" class="tsd-anchor"></a>
193 <h3>Commander</h3>
194 <div class="tsd-signature tsd-kind-icon">Commander<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommanderStatic</span></div>
195 <aside class="tsd-sources">
196 <ul>
197 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/Application.ts#L30">src/Application.ts:30</a></li>
198 </ul>
199 </aside>
200 </section>
201 <section class="tsd-panel tsd-member tsd-kind-variable">
202 <a name="default_high_watermark" class="tsd-anchor"></a>
203 <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>HIGH_<wbr>WATERMARK</h3>
204 <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>HIGH_<wbr>WATERMARK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 512</span></div>
205 <aside class="tsd-sources">
206 <ul>
207 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/MySQLConnection.ts#L26">src/MySQLConnection.ts:26</a></li>
208 </ul>
209 </aside>
210 </section>
211 <section class="tsd-panel tsd-member tsd-kind-variable">
212 <a name="default_log_level" class="tsd-anchor"></a>
213 <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>LOG_<wbr>LEVEL</h3>
214 <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>LOG_<wbr>LEVEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = LogSeverity.INFO | LogSeverity.WARNING | LogSeverity.ERROR | LogSeverity.FATAL</span></div>
215 <aside class="tsd-sources">
216 <ul>
217 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/Application.ts#L40">src/Application.ts:40</a></li>
218 </ul>
219 </aside>
220 <div class="tsd-comment tsd-typography">
221 <div class="lead">
222 <p>The default log level to log informational, warnings, errors, and fatal messages.</p>
223 </div>
224 </div>
225 </section>
226 <section class="tsd-panel tsd-member tsd-kind-variable">
227 <a name="default_query_timeout" class="tsd-anchor"></a>
228 <h3><span class="tsd-flag ts-flagConst">Const</span> DEFAULT_<wbr>QUERY_<wbr>TIMEOUT</h3>
229 <div class="tsd-signature tsd-kind-icon">DEFAULT_<wbr>QUERY_<wbr>TIMEOUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 3600000</span></div>
230 <aside class="tsd-sources">
231 <ul>
232 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/DatabaseConnection.ts#L26">src/DatabaseConnection.ts:26</a></li>
233 </ul>
234 </aside>
235 </section>
236 <section class="tsd-panel tsd-member tsd-kind-variable">
237 <a name="linger_warning" class="tsd-anchor"></a>
238 <h3><span class="tsd-flag ts-flagConst">Const</span> LINGER_<wbr>WARNING</h3>
239 <div class="tsd-signature tsd-kind-icon">LINGER_<wbr>WARNING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 10000</span></div>
240 <aside class="tsd-sources">
241 <ul>
242 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/DatabaseConnection.ts#L25">src/DatabaseConnection.ts:25</a></li>
243 </ul>
244 </aside>
245 </section>
246 <section class="tsd-panel tsd-member tsd-kind-variable">
247 <a name="master_name" class="tsd-anchor"></a>
248 <h3><span class="tsd-flag ts-flagConst">Const</span> MASTER_<wbr>NAME</h3>
249 <div class="tsd-signature tsd-kind-icon">MASTER_<wbr>NAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;MASTER&quot;</span></div>
250 <aside class="tsd-sources">
251 <ul>
252 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/Database.ts#L20">src/Database.ts:20</a></li>
253 </ul>
254 </aside>
255 </section>
256 <section class="tsd-panel tsd-member tsd-kind-variable">
257 <a name="no_data" class="tsd-anchor"></a>
258 <h3><span class="tsd-flag ts-flagConst">Const</span> NO_<wbr>DATA</h3>
259 <div class="tsd-signature tsd-kind-icon">NO_<wbr>DATA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;|${0x0}|&#x60;</span></div>
260 <aside class="tsd-sources">
261 <ul>
262 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/ServiceProvider.ts#L8">src/ServiceProvider.ts:8</a></li>
263 </ul>
264 </aside>
265 </section>
266 <section class="tsd-panel tsd-member tsd-kind-variable">
267 <a name="commitquery" class="tsd-anchor"></a>
268 <h3><span class="tsd-flag ts-flagConst">Const</span> commit<wbr>Query</h3>
269 <div class="tsd-signature tsd-kind-icon">commit<wbr>Query<span class="tsd-signature-symbol">:</span> <a href="classes/query.html" class="tsd-signature-type">Query</a><span class="tsd-signature-symbol"> = new CommitQuery()</span></div>
270 <aside class="tsd-sources">
271 <ul>
272 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/MySQLConnection.ts#L29">src/MySQLConnection.ts:29</a></li>
273 </ul>
274 </aside>
275 </section>
276 <section class="tsd-panel tsd-member tsd-kind-variable">
277 <a name="genericlogger" class="tsd-anchor"></a>
278 <h3><span class="tsd-flag ts-flagLet">Let</span> generic<wbr>Logger</h3>
279 <div class="tsd-signature tsd-kind-icon">generic<wbr>Logger<span class="tsd-signature-symbol">:</span> <a href="classes/logger.html" class="tsd-signature-type">Logger</a></div>
280 <aside class="tsd-sources">
281 <ul>
282 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/instance.ts#L23">src/instance.ts:23</a></li>
283 </ul>
284 </aside>
285 </section>
286 <section class="tsd-panel tsd-member tsd-kind-variable">
287 <a name="instance" class="tsd-anchor"></a>
288 <h3><span class="tsd-flag ts-flagLet">Let</span> instance</h3>
289 <div class="tsd-signature tsd-kind-icon">instance<span class="tsd-signature-symbol">:</span> <a href="classes/application.html" class="tsd-signature-type">Application</a></div>
290 <aside class="tsd-sources">
291 <ul>
292 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/instance.ts#L22">src/instance.ts:22</a></li>
293 </ul>
294 </aside>
295 </section>
296 <section class="tsd-panel tsd-member tsd-kind-variable">
297 <a name="rollbackquery" class="tsd-anchor"></a>
298 <h3><span class="tsd-flag ts-flagConst">Const</span> rollback<wbr>Query</h3>
299 <div class="tsd-signature tsd-kind-icon">rollback<wbr>Query<span class="tsd-signature-symbol">:</span> <a href="classes/query.html" class="tsd-signature-type">Query</a><span class="tsd-signature-symbol"> = new RollbackQuery()</span></div>
300 <aside class="tsd-sources">
301 <ul>
302 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/MySQLConnection.ts#L30">src/MySQLConnection.ts:30</a></li>
303 </ul>
304 </aside>
305 </section>
306 <section class="tsd-panel tsd-member tsd-kind-variable">
307 <a name="starttransactionquery" class="tsd-anchor"></a>
308 <h3><span class="tsd-flag ts-flagConst">Const</span> start<wbr>Transaction<wbr>Query</h3>
309 <div class="tsd-signature tsd-kind-icon">start<wbr>Transaction<wbr>Query<span class="tsd-signature-symbol">:</span> <a href="classes/query.html" class="tsd-signature-type">Query</a><span class="tsd-signature-symbol"> = new StartTransactionQuery()</span></div>
310 <aside class="tsd-sources">
311 <ul>
312 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/MySQLConnection.ts#L28">src/MySQLConnection.ts:28</a></li>
313 </ul>
314 </aside>
315 </section>
316 </section>
317 <section class="tsd-panel-group tsd-member-group ">
318 <h2>Functions</h2>
319 <section class="tsd-panel tsd-member tsd-kind-function">
320 <a name="getapplicationlogger" class="tsd-anchor"></a>
321 <h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Application<wbr>Logger</h3>
322 <ul class="tsd-signatures tsd-kind-function">
323 <li class="tsd-signature tsd-kind-icon">get<wbr>Application<wbr>Logger<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/logger.html" class="tsd-signature-type">Logger</a></li>
324 </ul>
325 <ul class="tsd-descriptions">
326 <li class="tsd-description">
327 <aside class="tsd-sources">
328 <ul>
329 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/instance.ts#L36">src/instance.ts:36</a></li>
330 </ul>
331 </aside>
332 <h4 class="tsd-returns-title">Returns <a href="classes/logger.html" class="tsd-signature-type">Logger</a></h4>
333 </li>
334 </ul>
335 </section>
336 <section class="tsd-panel tsd-member tsd-kind-function">
337 <a name="getinstance" class="tsd-anchor"></a>
338 <h3><span class="tsd-flag ts-flagConst">Const</span> get<wbr>Instance</h3>
339 <ul class="tsd-signatures tsd-kind-function">
340 <li class="tsd-signature tsd-kind-icon">get<wbr>Instance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/application.html" class="tsd-signature-type">Application</a></li>
341 </ul>
342 <ul class="tsd-descriptions">
343 <li class="tsd-description">
344 <aside class="tsd-sources">
345 <ul>
346 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/instance.ts#L32">src/instance.ts:32</a></li>
347 </ul>
348 </aside>
349 <h4 class="tsd-returns-title">Returns <a href="classes/application.html" class="tsd-signature-type">Application</a></h4>
350 </li>
351 </ul>
352 </section>
353 <section class="tsd-panel tsd-member tsd-kind-function">
354 <a name="setinstance" class="tsd-anchor"></a>
355 <h3><span class="tsd-flag ts-flagConst">Const</span> set<wbr>Instance</h3>
356 <ul class="tsd-signatures tsd-kind-function">
357 <li class="tsd-signature tsd-kind-icon">set<wbr>Instance<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><a href="classes/application.html" class="tsd-signature-type">Application</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
358 </ul>
359 <ul class="tsd-descriptions">
360 <li class="tsd-description">
361 <aside class="tsd-sources">
362 <ul>
363 <li>Defined in <a href="https://github.com/breautek/storm/blob/d525363/src/instance.ts#L25">src/instance.ts:25</a></li>
364 </ul>
365 </aside>
366 <h4 class="tsd-parameters-title">Parameters</h4>
367 <ul class="tsd-parameters">
368 <li>
369 <h5>app: <a href="classes/application.html" class="tsd-signature-type">Application</a></h5>
370 </li>
371 </ul>
372 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
373 </li>
374 </ul>
375 </section>
376 </section>
377 </div>
378 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
379 <nav class="tsd-navigation primary">
380 <ul>
381 <li class="globals current ">
382 <a href="globals.html"><em>Globals</em></a>
383 </li>
384 </ul>
385 </nav>
386 <nav class="tsd-navigation secondary menu-sticky">
387 <ul class="before-current">
388 <li class=" tsd-kind-enum">
389 <a href="enums/applicationevent.html" class="tsd-kind-icon">Application<wbr>Event</a>
390 </li>
391 <li class=" tsd-kind-enum">
392 <a href="enums/errorcode.html" class="tsd-kind-icon">Error<wbr>Code</a>
393 </li>
394 <li class=" tsd-kind-enum">
395 <a href="enums/exitcode.html" class="tsd-kind-icon">Exit<wbr>Code</a>
396 </li>
397 <li class=" tsd-kind-enum">
398 <a href="enums/httpmethod.html" class="tsd-kind-icon">HTTPMethod</a>
399 </li>
400 <li class=" tsd-kind-enum">
401 <a href="enums/logevent.html" class="tsd-kind-icon">Log<wbr>Event</a>
402 </li>
403 <li class=" tsd-kind-enum">
404 <a href="enums/logseverity.html" class="tsd-kind-icon">Log<wbr>Severity</a>
405 </li>
406 <li class=" tsd-kind-enum">
407 <a href="enums/statuscode.html" class="tsd-kind-icon">Status<wbr>Code</a>
408 </li>
409 <li class=" tsd-kind-class">
410 <a href="classes/application.html" class="tsd-kind-icon">Application</a>
411 </li>
412 <li class=" tsd-kind-class">
413 <a href="classes/authenticationmiddleware.html" class="tsd-kind-icon">Authentication<wbr>Middleware</a>
414 </li>
415 <li class=" tsd-kind-class">
416 <a href="classes/backendauthenticationmiddleware.html" class="tsd-kind-icon">Backend<wbr>Authentication<wbr>Middleware</a>
417 </li>
418 <li class=" tsd-kind-class">
419 <a href="classes/corsmiddleware.html" class="tsd-kind-icon">CORSMiddleware</a>
420 </li>
421 <li class=" tsd-kind-class">
422 <a href="classes/commitquery.html" class="tsd-kind-icon">Commit<wbr>Query</a>
423 </li>
424 <li class=" tsd-kind-class">
425 <a href="classes/configloader.html" class="tsd-kind-icon">Config<wbr>Loader</a>
426 </li>
427 <li class=" tsd-kind-class">
428 <a href="classes/database.html" class="tsd-kind-icon">Database</a>
429 </li>
430 <li class=" tsd-kind-class">
431 <a href="classes/databaseconnection.html" class="tsd-kind-icon">Database<wbr>Connection</a>
432 </li>
433 <li class=" tsd-kind-class">
434 <a href="classes/databasequeryerror.html" class="tsd-kind-icon">Database<wbr>Query<wbr>Error</a>
435 </li>
436 <li class=" tsd-kind-class">
437 <a href="classes/diskspaceerror.html" class="tsd-kind-icon">Disk<wbr>Space<wbr>Error</a>
438 </li>
439 <li class=" tsd-kind-class">
440 <a href="classes/dumpstream.html" class="tsd-kind-icon">Dump<wbr>Stream</a>
441 </li>
442 <li class=" tsd-kind-class">
443 <a href="classes/duplicateentryerror.html" class="tsd-kind-icon">Duplicate<wbr>Entry<wbr>Error</a>
444 </li>
445 <li class=" tsd-kind-class">
446 <a href="classes/entitynotfounderror.html" class="tsd-kind-icon">Entity<wbr>Not<wbr>Found<wbr>Error</a>
447 </li>
448 <li class=" tsd-kind-class">
449 <a href="classes/expiredtokenerror.html" class="tsd-kind-icon">Expired<wbr>Token<wbr>Error</a>
450 </li>
451 <li class=" tsd-kind-class tsd-has-type-parameter">
452 <a href="classes/handler.html" class="tsd-kind-icon">Handler</a>
453 </li>
454 <li class=" tsd-kind-class">
455 <a href="classes/internalerror.html" class="tsd-kind-icon">Internal<wbr>Error</a>
456 </li>
457 <li class=" tsd-kind-class">
458 <a href="classes/invalidcredentialserror.html" class="tsd-kind-icon">Invalid<wbr>Credentials<wbr>Error</a>
459 </li>
460 <li class=" tsd-kind-class">
461 <a href="classes/invalidvalueerror.html" class="tsd-kind-icon">Invalid<wbr>Value<wbr>Error</a>
462 </li>
463 <li class=" tsd-kind-class">
464 <a href="classes/jwtverifyoptionsparser.html" class="tsd-kind-icon">JWTVerify<wbr>Options<wbr>Parser</a>
465 </li>
466 <li class=" tsd-kind-class">
467 <a href="classes/logger.html" class="tsd-kind-icon">Logger</a>
468 </li>
469 <li class=" tsd-kind-class">
470 <a href="classes/loggermiddleware.html" class="tsd-kind-icon">Logger<wbr>Middleware</a>
471 </li>
472 <li class=" tsd-kind-class">
473 <a href="classes/manageddatabaseconnection.html" class="tsd-kind-icon">Managed<wbr>Database<wbr>Connection</a>
474 </li>
475 <li class=" tsd-kind-class">
476 <a href="classes/middleware.html" class="tsd-kind-icon">Middleware</a>
477 </li>
478 <li class=" tsd-kind-class">
479 <a href="classes/missingparametererror.html" class="tsd-kind-icon">Missing<wbr>Parameter<wbr>Error</a>
480 </li>
481 <li class=" tsd-kind-class">
482 <a href="classes/mysqlconnection.html" class="tsd-kind-icon">MySQLConnection</a>
483 </li>
484 <li class=" tsd-kind-class">
485 <a href="classes/mysqldatabase.html" class="tsd-kind-icon">MySQLDatabase</a>
486 </li>
487 <li class=" tsd-kind-class">
488 <a href="classes/query.html" class="tsd-kind-icon">Query</a>
489 </li>
490 <li class=" tsd-kind-class tsd-has-type-parameter">
491 <a href="classes/request.html" class="tsd-kind-icon">Request</a>
492 </li>
493 <li class=" tsd-kind-class tsd-has-type-parameter">
494 <a href="classes/response.html" class="tsd-kind-icon">Response</a>
495 </li>
496 <li class=" tsd-kind-class tsd-has-type-parameter">
497 <a href="classes/responsedata.html" class="tsd-kind-icon">Response<wbr>Data</a>
498 </li>
499 <li class=" tsd-kind-class">
500 <a href="classes/rollbackquery.html" class="tsd-kind-icon">Rollback<wbr>Query</a>
501 </li>
502 <li class=" tsd-kind-class">
503 <a href="classes/serviceprovider.html" class="tsd-kind-icon">Service<wbr>Provider</a>
504 </li>
505 <li class=" tsd-kind-class">
506 <a href="classes/serviceresponse.html" class="tsd-kind-icon">Service<wbr>Response</a>
507 </li>
508 <li class=" tsd-kind-class">
509 <a href="classes/starttransactionquery.html" class="tsd-kind-icon">Start<wbr>Transaction<wbr>Query</a>
510 </li>
511 <li class=" tsd-kind-class">
512 <a href="classes/stormerror.html" class="tsd-kind-icon">Storm<wbr>Error</a>
513 </li>
514 <li class=" tsd-kind-class">
515 <a href="classes/token.html" class="tsd-kind-icon">Token</a>
516 </li>
517 <li class=" tsd-kind-class">
518 <a href="classes/tokenmanager.html" class="tsd-kind-icon">Token<wbr>Manager</a>
519 </li>
520 <li class=" tsd-kind-class">
521 <a href="classes/unauthorizedaccesserror.html" class="tsd-kind-icon">Unauthorized<wbr>Access<wbr>Error</a>
522 </li>
523 <li class=" tsd-kind-interface">
524 <a href="interfaces/iadditionalerrordetails.html" class="tsd-kind-icon">IAdditional<wbr>Error<wbr>Details</a>
525 </li>
526 <li class=" tsd-kind-interface">
527 <a href="interfaces/iconfig.html" class="tsd-kind-icon">IConfig</a>
528 </li>
529 <li class=" tsd-kind-interface">
530 <a href="interfaces/idatabaseconnection.html" class="tsd-kind-icon">IDatabase<wbr>Connection</a>
531 </li>
532 <li class=" tsd-kind-interface">
533 <a href="interfaces/iduplicateentryerroroptions.html" class="tsd-kind-icon">IDuplicate<wbr>Entry<wbr>Error<wbr>Options</a>
534 </li>
535 <li class=" tsd-kind-interface">
536 <a href="interfaces/ierrorresponse.html" class="tsd-kind-icon">IError<wbr>Response</a>
537 </li>
538 <li class=" tsd-kind-interface">
539 <a href="interfaces/iformdata.html" class="tsd-kind-icon">IForm<wbr>Data</a>
540 </li>
541 <li class=" tsd-kind-interface">
542 <a href="interfaces/ihandler.html" class="tsd-kind-icon">IHandler</a>
543 </li>
544 <li class=" tsd-kind-interface">
545 <a href="interfaces/iheaderkeyvaluepair.html" class="tsd-kind-icon">IHeader<wbr>Key<wbr>Value<wbr>Pair</a>
546 </li>
547 <li class=" tsd-kind-interface">
548 <a href="interfaces/ijwtverifyoptions.html" class="tsd-kind-icon">IJWTVerify<wbr>Options</a>
549 </li>
550 <li class=" tsd-kind-interface">
551 <a href="interfaces/ilogevent.html" class="tsd-kind-icon">ILog<wbr>Event</a>
552 </li>
553 <li class=" tsd-kind-interface">
554 <a href="interfaces/iparametermap.html" class="tsd-kind-icon">IParameter<wbr>Map</a>
555 </li>
556 <li class=" tsd-kind-interface">
557 <a href="interfaces/iqueryparameters.html" class="tsd-kind-icon">IQuery<wbr>Parameters</a>
558 </li>
559 <li class=" tsd-kind-interface tsd-has-type-parameter">
560 <a href="interfaces/irequestresponse.html" class="tsd-kind-icon">IRequest<wbr>Response</a>
561 </li>
562 <li class=" tsd-kind-interface">
563 <a href="interfaces/iserviceheaders.html" class="tsd-kind-icon">IService<wbr>Headers</a>
564 </li>
565 <li class=" tsd-kind-type-alias">
566 <a href="globals.html#sendabledata" class="tsd-kind-icon">Sendable<wbr>Data</a>
567 </li>
568 <li class=" tsd-kind-variable">
569 <a href="globals.html#commander" class="tsd-kind-icon">Commander</a>
570 </li>
571 <li class=" tsd-kind-variable">
572 <a href="globals.html#default_high_watermark" class="tsd-kind-icon">DEFAULT_<wbr>HIGH_<wbr>WATERMARK</a>
573 </li>
574 <li class=" tsd-kind-variable">
575 <a href="globals.html#default_log_level" class="tsd-kind-icon">DEFAULT_<wbr>LOG_<wbr>LEVEL</a>
576 </li>
577 <li class=" tsd-kind-variable">
578 <a href="globals.html#default_query_timeout" class="tsd-kind-icon">DEFAULT_<wbr>QUERY_<wbr>TIMEOUT</a>
579 </li>
580 <li class=" tsd-kind-variable">
581 <a href="globals.html#linger_warning" class="tsd-kind-icon">LINGER_<wbr>WARNING</a>
582 </li>
583 <li class=" tsd-kind-variable">
584 <a href="globals.html#master_name" class="tsd-kind-icon">MASTER_<wbr>NAME</a>
585 </li>
586 <li class=" tsd-kind-variable">
587 <a href="globals.html#no_data" class="tsd-kind-icon">NO_<wbr>DATA</a>
588 </li>
589 <li class=" tsd-kind-variable">
590 <a href="globals.html#commitquery" class="tsd-kind-icon">commit<wbr>Query</a>
591 </li>
592 <li class=" tsd-kind-variable">
593 <a href="globals.html#genericlogger" class="tsd-kind-icon">generic<wbr>Logger</a>
594 </li>
595 <li class=" tsd-kind-variable">
596 <a href="globals.html#instance" class="tsd-kind-icon">instance</a>
597 </li>
598 <li class=" tsd-kind-variable">
599 <a href="globals.html#rollbackquery" class="tsd-kind-icon">rollback<wbr>Query</a>
600 </li>
601 <li class=" tsd-kind-variable">
602 <a href="globals.html#starttransactionquery" class="tsd-kind-icon">start<wbr>Transaction<wbr>Query</a>
603 </li>
604 <li class=" tsd-kind-function">
605 <a href="globals.html#getapplicationlogger" class="tsd-kind-icon">get<wbr>Application<wbr>Logger</a>
606 </li>
607 <li class=" tsd-kind-function">
608 <a href="globals.html#getinstance" class="tsd-kind-icon">get<wbr>Instance</a>
609 </li>
610 <li class=" tsd-kind-function">
611 <a href="globals.html#setinstance" class="tsd-kind-icon">set<wbr>Instance</a>
612 </li>
613 </ul>
614 </nav>
615 </div>
616 </div>
617</div>
618<footer class="with-border-bottom">
619 <div class="container">
620 <h2>Legend</h2>
621 <div class="tsd-legend-group">
622 <ul class="tsd-legend">
623 <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
624 <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
625 <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
626 </ul>
627 <ul class="tsd-legend">
628 <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
629 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
630 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
631 </ul>
632 <ul class="tsd-legend">
633 <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
634 <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
635 </ul>
636 <ul class="tsd-legend">
637 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
638 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
639 </ul>
640 <ul class="tsd-legend">
641 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
642 </ul>
643 </div>
644 </div>
645</footer>
646<div class="container tsd-generator">
647 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
648</div>
649<div class="overlay"></div>
650<script src="assets/js/main.js"></script>
651</body>
652</html>
\No newline at end of file