@breautek/storm 5.0.1-beta.3 → 5.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/CHANGELOG.md +18 -2
  2. package/docs/assets/highlight.css +85 -0
  3. package/docs/assets/main.js +58 -0
  4. package/docs/assets/search.js +1 -0
  5. package/docs/assets/style.css +1367 -0
  6. package/docs/classes/Application.html +1235 -0
  7. package/docs/classes/BackendAuthenticationMiddleware.html +191 -0
  8. package/docs/classes/CORSMiddleware.html +257 -0
  9. package/docs/classes/ConfigLoader.html +166 -0
  10. package/docs/classes/Database.html +340 -0
  11. package/docs/classes/DatabaseCastObject.html +203 -0
  12. package/docs/classes/DatabaseConnection.html +550 -0
  13. package/docs/classes/DatabaseQueryError.html +372 -0
  14. package/docs/classes/DeadLockError.html +372 -0
  15. package/docs/classes/DiskSpaceError.html +362 -0
  16. package/docs/classes/DropTemporaryTableQuery.html +285 -0
  17. package/docs/classes/DumpStream.html +161 -0
  18. package/docs/classes/DuplicateEntryError.html +366 -0
  19. package/docs/classes/EntityNotFoundError.html +362 -0
  20. package/docs/classes/ExpiredTokenError.html +362 -0
  21. package/docs/classes/Handler.html +395 -0
  22. package/docs/classes/InternalError.html +362 -0
  23. package/docs/classes/InvalidCredentialsError.html +362 -0
  24. package/docs/classes/InvalidValueError.html +373 -0
  25. package/docs/classes/LineString.html +212 -0
  26. package/docs/classes/LockWaitTimeoutError.html +372 -0
  27. package/docs/classes/ManagedDatabaseConnection.html +410 -0
  28. package/docs/classes/Middleware.html +202 -0
  29. package/docs/classes/MissingConfigError.html +362 -0
  30. package/docs/classes/MissingParameterError.html +362 -0
  31. package/docs/classes/MySQLConnection.html +546 -0
  32. package/docs/classes/MySQLDatabase.html +353 -0
  33. package/docs/classes/NotImplementedError.html +362 -0
  34. package/docs/classes/Point.html +214 -0
  35. package/docs/classes/Polygon.html +212 -0
  36. package/docs/classes/Query.html +312 -0
  37. package/docs/classes/RawError.html +374 -0
  38. package/docs/classes/RawQuery.html +305 -0
  39. package/docs/classes/Request.html +375 -0
  40. package/docs/classes/Response.html +329 -0
  41. package/docs/classes/ResponseData.html +255 -0
  42. package/docs/classes/ServiceProvider.html +385 -0
  43. package/docs/classes/ServiceResponse.html +213 -0
  44. package/docs/classes/SetSessionVariableQuery.html +285 -0
  45. package/docs/classes/StormError.html +377 -0
  46. package/docs/classes/TemporaryTableQuery.html +290 -0
  47. package/docs/classes/Token.html +181 -0
  48. package/docs/classes/TokenManager.html +233 -0
  49. package/docs/classes/Transaction.html +267 -0
  50. package/docs/classes/UnauthorizedAccessError.html +362 -0
  51. package/docs/enums/ErrorCode.html +210 -0
  52. package/docs/enums/ExitCode.html +161 -0
  53. package/docs/enums/HTTPMethod.html +175 -0
  54. package/docs/enums/IsolationLevel.html +175 -0
  55. package/docs/enums/JWTError.html +161 -0
  56. package/docs/enums/StatusCode.html +483 -0
  57. package/docs/functions/formidable-1.html +143 -0
  58. package/docs/functions/getInstance.html +138 -0
  59. package/docs/index.html +224 -0
  60. package/docs/interfaces/IAdditionalErrorDetails.html +140 -0
  61. package/docs/interfaces/IAuthTokenData.html +172 -0
  62. package/docs/interfaces/IConfig.html +225 -0
  63. package/docs/interfaces/IDatabaseConfig.html +198 -0
  64. package/docs/interfaces/IDatabaseConnection.html +332 -0
  65. package/docs/interfaces/IErrorResponse.html +186 -0
  66. package/docs/interfaces/IFormData.html +165 -0
  67. package/docs/interfaces/IHandler.html +171 -0
  68. package/docs/interfaces/IInsertQueryResult.html +172 -0
  69. package/docs/interfaces/IJWTVerifyOptions.html +158 -0
  70. package/docs/interfaces/IParameterMap.html +140 -0
  71. package/docs/interfaces/IQueryable.html +233 -0
  72. package/docs/interfaces/IRequestResponse.html +172 -0
  73. package/docs/interfaces/IServiceHeaders.html +140 -0
  74. package/docs/interfaces/ISetSessionVariableQueryInput.html +165 -0
  75. package/docs/interfaces/ITemporaryTableQueryInput.html +165 -0
  76. package/docs/interfaces/IUpdateQueryResult.html +165 -0
  77. package/docs/interfaces/formidable.EmitData.html +180 -0
  78. package/docs/interfaces/formidable.EventData.html +201 -0
  79. package/docs/interfaces/formidable.Fields.html +141 -0
  80. package/docs/interfaces/formidable.File.html +239 -0
  81. package/docs/interfaces/formidable.FileJSON.html +238 -0
  82. package/docs/interfaces/formidable.Files.html +141 -0
  83. package/docs/interfaces/formidable.Options.html +308 -0
  84. package/docs/interfaces/formidable.Part.html +691 -0
  85. package/docs/modules/formidable.html +159 -0
  86. package/docs/types/IDeleteQueryResult.html +134 -0
  87. package/docs/types/IHandlerError.html +139 -0
  88. package/docs/types/IHandlerResponse.html +145 -0
  89. package/docs/types/TCoordinate.html +134 -0
  90. package/docs/types/formidable.BufferEncoding.html +135 -0
  91. package/docs/types/formidable.DefaultOptions.html +135 -0
  92. package/docs/types/formidable.EnabledPlugins.html +135 -0
  93. package/docs/types/formidable.EventNames.html +135 -0
  94. package/docs/types/formidable.MappedParsers.html +135 -0
  95. package/docs/types/formidable.Plugin.html +135 -0
  96. package/docs/types/formidable.PluginFunction.html +150 -0
  97. package/docs/types/formidable.Plugins.html +135 -0
  98. package/lib/StatusCode.d.ts +1 -1
  99. package/lib/StatusCode.js +1 -1
  100. package/lib/Transaction.d.ts +4 -0
  101. package/lib/Transaction.js +4 -0
  102. package/lib/Transaction.js.map +1 -1
  103. package/package.json +14 -14
  104. package/src/StatusCode.ts +1 -1
  105. package/src/Transaction.ts +4 -0
  106. package/docs/README.md +0 -188
  107. package/docs/classes/Application.md +0 -1648
  108. package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
  109. package/docs/classes/CORSMiddleware.md +0 -143
  110. package/docs/classes/ConfigLoader.md +0 -29
  111. package/docs/classes/Database.md +0 -259
  112. package/docs/classes/DatabaseCastObject.md +0 -79
  113. package/docs/classes/DatabaseConnection.md +0 -556
  114. package/docs/classes/DatabaseQueryError.md +0 -351
  115. package/docs/classes/DeadLockError.md +0 -349
  116. package/docs/classes/DiskSpaceError.md +0 -341
  117. package/docs/classes/DropTemporaryTableQuery.md +0 -207
  118. package/docs/classes/DumpStream.md +0 -23
  119. package/docs/classes/DuplicateEntryError.md +0 -343
  120. package/docs/classes/EntityNotFoundError.md +0 -341
  121. package/docs/classes/ExpiredTokenError.md +0 -341
  122. package/docs/classes/Handler.md +0 -302
  123. package/docs/classes/InternalError.md +0 -341
  124. package/docs/classes/InvalidCredentialsError.md +0 -341
  125. package/docs/classes/InvalidValueError.md +0 -349
  126. package/docs/classes/LineString.md +0 -101
  127. package/docs/classes/LockWaitTimeoutError.md +0 -349
  128. package/docs/classes/ManagedDatabaseConnection.md +0 -403
  129. package/docs/classes/Middleware.md +0 -72
  130. package/docs/classes/MissingConfigError.md +0 -341
  131. package/docs/classes/MissingParameterError.md +0 -341
  132. package/docs/classes/MySQLConnection.md +0 -569
  133. package/docs/classes/MySQLDatabase.md +0 -314
  134. package/docs/classes/NotImplementedError.md +0 -341
  135. package/docs/classes/Point.md +0 -102
  136. package/docs/classes/Polygon.md +0 -101
  137. package/docs/classes/Query.md +0 -227
  138. package/docs/classes/RawError.md +0 -351
  139. package/docs/classes/RawQuery.md +0 -224
  140. package/docs/classes/Request.md +0 -321
  141. package/docs/classes/Response.md +0 -242
  142. package/docs/classes/ResponseData.md +0 -144
  143. package/docs/classes/ServiceProvider.md +0 -296
  144. package/docs/classes/ServiceResponse.md +0 -89
  145. package/docs/classes/SetSessionVariableQuery.md +0 -207
  146. package/docs/classes/StormError.md +0 -343
  147. package/docs/classes/TemporaryTableQuery.md +0 -213
  148. package/docs/classes/Token.md +0 -43
  149. package/docs/classes/TokenManager.md +0 -105
  150. package/docs/classes/Transaction.md +0 -161
  151. package/docs/classes/UnauthorizedAccessError.md +0 -341
  152. package/docs/enums/ErrorCode.md +0 -107
  153. package/docs/enums/ExitCode.md +0 -30
  154. package/docs/enums/HTTPMethod.md +0 -52
  155. package/docs/enums/IsolationLevel.md +0 -52
  156. package/docs/enums/JWTError.md +0 -30
  157. package/docs/enums/StatusCode.md +0 -536
  158. package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
  159. package/docs/interfaces/IAuthTokenData.md +0 -41
  160. package/docs/interfaces/IConfig.md +0 -112
  161. package/docs/interfaces/IDatabaseConfig.md +0 -80
  162. package/docs/interfaces/IDatabaseConnection.md +0 -262
  163. package/docs/interfaces/IErrorResponse.md +0 -63
  164. package/docs/interfaces/IFormData.md +0 -30
  165. package/docs/interfaces/IHandler.md +0 -31
  166. package/docs/interfaces/IInsertQueryResult.md +0 -41
  167. package/docs/interfaces/IJWTVerifyOptions.md +0 -19
  168. package/docs/interfaces/IParameterMap.md +0 -7
  169. package/docs/interfaces/IQueryable.md +0 -119
  170. package/docs/interfaces/IRequestResponse.md +0 -37
  171. package/docs/interfaces/IServiceHeaders.md +0 -7
  172. package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
  173. package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
  174. package/docs/interfaces/IUpdateQueryResult.md +0 -30
  175. package/docs/interfaces/formidable.EmitData.md +0 -54
  176. package/docs/interfaces/formidable.EventData.md +0 -87
  177. package/docs/interfaces/formidable.Fields.md +0 -9
  178. package/docs/interfaces/formidable.File.md +0 -131
  179. package/docs/interfaces/formidable.FileJSON.md +0 -151
  180. package/docs/interfaces/formidable.Files.md +0 -9
  181. package/docs/interfaces/formidable.Options.md +0 -225
  182. package/docs/interfaces/formidable.Part.md +0 -793
  183. package/docs/modules/formidable.md +0 -122
@@ -1,343 +0,0 @@
1
- [@breautek/storm](../README.md) / DuplicateEntryError
2
-
3
- # Class: DuplicateEntryError
4
-
5
- ## Hierarchy
6
-
7
- - [`StormError`](StormError.md)
8
-
9
- ↳ **`DuplicateEntryError`**
10
-
11
- ## Table of contents
12
-
13
- ### Constructors
14
-
15
- - [constructor](DuplicateEntryError.md#constructor)
16
-
17
- ### Properties
18
-
19
- - [message](DuplicateEntryError.md#message)
20
- - [name](DuplicateEntryError.md#name)
21
- - [stack](DuplicateEntryError.md#stack)
22
- - [prepareStackTrace](DuplicateEntryError.md#preparestacktrace)
23
- - [stackTraceLimit](DuplicateEntryError.md#stacktracelimit)
24
-
25
- ### Methods
26
-
27
- - [getCode](DuplicateEntryError.md#getcode)
28
- - [getErrorResponse](DuplicateEntryError.md#geterrorresponse)
29
- - [getExitCode](DuplicateEntryError.md#getexitcode)
30
- - [getHTTPCode](DuplicateEntryError.md#gethttpcode)
31
- - [getLocaleCode](DuplicateEntryError.md#getlocalecode)
32
- - [getLocaleParameters](DuplicateEntryError.md#getlocaleparameters)
33
- - [getMessage](DuplicateEntryError.md#getmessage)
34
- - [getPrivateDetails](DuplicateEntryError.md#getprivatedetails)
35
- - [getPublicDetails](DuplicateEntryError.md#getpublicdetails)
36
- - [captureStackTrace](DuplicateEntryError.md#capturestacktrace)
37
-
38
- ## Constructors
39
-
40
- ### constructor
41
-
42
- • **new DuplicateEntryError**(`entity`, `name`, `property?`)
43
-
44
- #### Parameters
45
-
46
- | Name | Type | Default value |
47
- | :------ | :------ | :------ |
48
- | `entity` | `string` | `undefined` |
49
- | `name` | `string` | `undefined` |
50
- | `property` | `string` | `'name'` |
51
-
52
- #### Overrides
53
-
54
- [StormError](StormError.md).[constructor](StormError.md#constructor)
55
-
56
- #### Defined in
57
-
58
- [src/DuplicateEntryError.ts:28](https://github.com/breautek/storm/blob/d45307d/src/DuplicateEntryError.ts#L28)
59
-
60
- ## Properties
61
-
62
- ### message
63
-
64
- • **message**: `string`
65
-
66
- #### Inherited from
67
-
68
- [StormError](StormError.md).[message](StormError.md#message)
69
-
70
- #### Defined in
71
-
72
- node_modules/typescript/lib/lib.es5.d.ts:1054
73
-
74
- ___
75
-
76
- ### name
77
-
78
- • **name**: `string`
79
-
80
- #### Inherited from
81
-
82
- [StormError](StormError.md).[name](StormError.md#name)
83
-
84
- #### Defined in
85
-
86
- node_modules/typescript/lib/lib.es5.d.ts:1053
87
-
88
- ___
89
-
90
- ### stack
91
-
92
- • `Optional` **stack**: `string`
93
-
94
- #### Inherited from
95
-
96
- [StormError](StormError.md).[stack](StormError.md#stack)
97
-
98
- #### Defined in
99
-
100
- node_modules/typescript/lib/lib.es5.d.ts:1055
101
-
102
- ___
103
-
104
- ### prepareStackTrace
105
-
106
- ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
107
-
108
- #### Type declaration
109
-
110
- ▸ (`err`, `stackTraces`): `any`
111
-
112
- Optional override for formatting stack traces
113
-
114
- **`See`**
115
-
116
- https://v8.dev/docs/stack-trace-api#customizing-stack-traces
117
-
118
- ##### Parameters
119
-
120
- | Name | Type |
121
- | :------ | :------ |
122
- | `err` | `Error` |
123
- | `stackTraces` | `CallSite`[] |
124
-
125
- ##### Returns
126
-
127
- `any`
128
-
129
- #### Inherited from
130
-
131
- [StormError](StormError.md).[prepareStackTrace](StormError.md#preparestacktrace)
132
-
133
- #### Defined in
134
-
135
- node_modules/@types/node/globals.d.ts:11
136
-
137
- ___
138
-
139
- ### stackTraceLimit
140
-
141
- ▪ `Static` **stackTraceLimit**: `number`
142
-
143
- #### Inherited from
144
-
145
- [StormError](StormError.md).[stackTraceLimit](StormError.md#stacktracelimit)
146
-
147
- #### Defined in
148
-
149
- node_modules/@types/node/globals.d.ts:13
150
-
151
- ## Methods
152
-
153
- ### getCode
154
-
155
- ▸ **getCode**(): [`ErrorCode`](../enums/ErrorCode.md)
156
-
157
- #### Returns
158
-
159
- [`ErrorCode`](../enums/ErrorCode.md)
160
-
161
- #### Overrides
162
-
163
- [StormError](StormError.md).[getCode](StormError.md#getcode)
164
-
165
- #### Defined in
166
-
167
- [src/DuplicateEntryError.ts:41](https://github.com/breautek/storm/blob/d45307d/src/DuplicateEntryError.ts#L41)
168
-
169
- ___
170
-
171
- ### getErrorResponse
172
-
173
- ▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
174
-
175
- #### Returns
176
-
177
- [`IErrorResponse`](../interfaces/IErrorResponse.md)
178
-
179
- #### Inherited from
180
-
181
- [StormError](StormError.md).[getErrorResponse](StormError.md#geterrorresponse)
182
-
183
- #### Defined in
184
-
185
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L76)
186
-
187
- ___
188
-
189
- ### getExitCode
190
-
191
- ▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
192
-
193
- #### Returns
194
-
195
- [`ExitCode`](../enums/ExitCode.md)
196
-
197
- #### Inherited from
198
-
199
- [StormError](StormError.md).[getExitCode](StormError.md#getexitcode)
200
-
201
- #### Defined in
202
-
203
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L97)
204
-
205
- ___
206
-
207
- ### getHTTPCode
208
-
209
- ▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
210
-
211
- #### Returns
212
-
213
- [`StatusCode`](../enums/StatusCode.md)
214
-
215
- #### Overrides
216
-
217
- [StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
218
-
219
- #### Defined in
220
-
221
- [src/DuplicateEntryError.ts:45](https://github.com/breautek/storm/blob/d45307d/src/DuplicateEntryError.ts#L45)
222
-
223
- ___
224
-
225
- ### getLocaleCode
226
-
227
- ▸ **getLocaleCode**(): `string`
228
-
229
- #### Returns
230
-
231
- `string`
232
-
233
- #### Overrides
234
-
235
- [StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
236
-
237
- #### Defined in
238
-
239
- [src/DuplicateEntryError.ts:49](https://github.com/breautek/storm/blob/d45307d/src/DuplicateEntryError.ts#L49)
240
-
241
- ___
242
-
243
- ### getLocaleParameters
244
-
245
- ▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
246
-
247
- #### Returns
248
-
249
- `Record`<`string`, `string`\>
250
-
251
- #### Overrides
252
-
253
- [StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
254
-
255
- #### Defined in
256
-
257
- [src/DuplicateEntryError.ts:53](https://github.com/breautek/storm/blob/d45307d/src/DuplicateEntryError.ts#L53)
258
-
259
- ___
260
-
261
- ### getMessage
262
-
263
- ▸ **getMessage**(): `string`
264
-
265
- #### Returns
266
-
267
- `string`
268
-
269
- #### Overrides
270
-
271
- [StormError](StormError.md).[getMessage](StormError.md#getmessage)
272
-
273
- #### Defined in
274
-
275
- [src/DuplicateEntryError.ts:36](https://github.com/breautek/storm/blob/d45307d/src/DuplicateEntryError.ts#L36)
276
-
277
- ___
278
-
279
- ### getPrivateDetails
280
-
281
- ▸ **getPrivateDetails**(): `any`
282
-
283
- Private details are only logged to the server log.
284
- They are kept secret from the client.
285
-
286
- #### Returns
287
-
288
- `any`
289
-
290
- #### Inherited from
291
-
292
- [StormError](StormError.md).[getPrivateDetails](StormError.md#getprivatedetails)
293
-
294
- #### Defined in
295
-
296
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L68)
297
-
298
- ___
299
-
300
- ### getPublicDetails
301
-
302
- ▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
303
-
304
- Sends details to the client.
305
-
306
- #### Returns
307
-
308
- [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
309
-
310
- #### Inherited from
311
-
312
- [StormError](StormError.md).[getPublicDetails](StormError.md#getpublicdetails)
313
-
314
- #### Defined in
315
-
316
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L60)
317
-
318
- ___
319
-
320
- ### captureStackTrace
321
-
322
- ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
323
-
324
- Create .stack property on a target object
325
-
326
- #### Parameters
327
-
328
- | Name | Type |
329
- | :------ | :------ |
330
- | `targetObject` | `object` |
331
- | `constructorOpt?` | `Function` |
332
-
333
- #### Returns
334
-
335
- `void`
336
-
337
- #### Inherited from
338
-
339
- [StormError](StormError.md).[captureStackTrace](StormError.md#capturestacktrace)
340
-
341
- #### Defined in
342
-
343
- node_modules/@types/node/globals.d.ts:4
@@ -1,341 +0,0 @@
1
- [@breautek/storm](../README.md) / EntityNotFoundError
2
-
3
- # Class: EntityNotFoundError
4
-
5
- ## Hierarchy
6
-
7
- - [`StormError`](StormError.md)
8
-
9
- ↳ **`EntityNotFoundError`**
10
-
11
- ## Table of contents
12
-
13
- ### Constructors
14
-
15
- - [constructor](EntityNotFoundError.md#constructor)
16
-
17
- ### Properties
18
-
19
- - [message](EntityNotFoundError.md#message)
20
- - [name](EntityNotFoundError.md#name)
21
- - [stack](EntityNotFoundError.md#stack)
22
- - [prepareStackTrace](EntityNotFoundError.md#preparestacktrace)
23
- - [stackTraceLimit](EntityNotFoundError.md#stacktracelimit)
24
-
25
- ### Methods
26
-
27
- - [getCode](EntityNotFoundError.md#getcode)
28
- - [getErrorResponse](EntityNotFoundError.md#geterrorresponse)
29
- - [getExitCode](EntityNotFoundError.md#getexitcode)
30
- - [getHTTPCode](EntityNotFoundError.md#gethttpcode)
31
- - [getLocaleCode](EntityNotFoundError.md#getlocalecode)
32
- - [getLocaleParameters](EntityNotFoundError.md#getlocaleparameters)
33
- - [getMessage](EntityNotFoundError.md#getmessage)
34
- - [getPrivateDetails](EntityNotFoundError.md#getprivatedetails)
35
- - [getPublicDetails](EntityNotFoundError.md#getpublicdetails)
36
- - [captureStackTrace](EntityNotFoundError.md#capturestacktrace)
37
-
38
- ## Constructors
39
-
40
- ### constructor
41
-
42
- • **new EntityNotFoundError**(`name`)
43
-
44
- #### Parameters
45
-
46
- | Name | Type |
47
- | :------ | :------ |
48
- | `name` | `string` |
49
-
50
- #### Overrides
51
-
52
- [StormError](StormError.md).[constructor](StormError.md#constructor)
53
-
54
- #### Defined in
55
-
56
- [src/EntityNotFoundError.ts:22](https://github.com/breautek/storm/blob/d45307d/src/EntityNotFoundError.ts#L22)
57
-
58
- ## Properties
59
-
60
- ### message
61
-
62
- • **message**: `string`
63
-
64
- #### Inherited from
65
-
66
- [StormError](StormError.md).[message](StormError.md#message)
67
-
68
- #### Defined in
69
-
70
- node_modules/typescript/lib/lib.es5.d.ts:1054
71
-
72
- ___
73
-
74
- ### name
75
-
76
- • **name**: `string`
77
-
78
- #### Inherited from
79
-
80
- [StormError](StormError.md).[name](StormError.md#name)
81
-
82
- #### Defined in
83
-
84
- node_modules/typescript/lib/lib.es5.d.ts:1053
85
-
86
- ___
87
-
88
- ### stack
89
-
90
- • `Optional` **stack**: `string`
91
-
92
- #### Inherited from
93
-
94
- [StormError](StormError.md).[stack](StormError.md#stack)
95
-
96
- #### Defined in
97
-
98
- node_modules/typescript/lib/lib.es5.d.ts:1055
99
-
100
- ___
101
-
102
- ### prepareStackTrace
103
-
104
- ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
105
-
106
- #### Type declaration
107
-
108
- ▸ (`err`, `stackTraces`): `any`
109
-
110
- Optional override for formatting stack traces
111
-
112
- **`See`**
113
-
114
- https://v8.dev/docs/stack-trace-api#customizing-stack-traces
115
-
116
- ##### Parameters
117
-
118
- | Name | Type |
119
- | :------ | :------ |
120
- | `err` | `Error` |
121
- | `stackTraces` | `CallSite`[] |
122
-
123
- ##### Returns
124
-
125
- `any`
126
-
127
- #### Inherited from
128
-
129
- [StormError](StormError.md).[prepareStackTrace](StormError.md#preparestacktrace)
130
-
131
- #### Defined in
132
-
133
- node_modules/@types/node/globals.d.ts:11
134
-
135
- ___
136
-
137
- ### stackTraceLimit
138
-
139
- ▪ `Static` **stackTraceLimit**: `number`
140
-
141
- #### Inherited from
142
-
143
- [StormError](StormError.md).[stackTraceLimit](StormError.md#stacktracelimit)
144
-
145
- #### Defined in
146
-
147
- node_modules/@types/node/globals.d.ts:13
148
-
149
- ## Methods
150
-
151
- ### getCode
152
-
153
- ▸ **getCode**(): [`ErrorCode`](../enums/ErrorCode.md)
154
-
155
- #### Returns
156
-
157
- [`ErrorCode`](../enums/ErrorCode.md)
158
-
159
- #### Overrides
160
-
161
- [StormError](StormError.md).[getCode](StormError.md#getcode)
162
-
163
- #### Defined in
164
-
165
- [src/EntityNotFoundError.ts:30](https://github.com/breautek/storm/blob/d45307d/src/EntityNotFoundError.ts#L30)
166
-
167
- ___
168
-
169
- ### getErrorResponse
170
-
171
- ▸ **getErrorResponse**(): [`IErrorResponse`](../interfaces/IErrorResponse.md)
172
-
173
- #### Returns
174
-
175
- [`IErrorResponse`](../interfaces/IErrorResponse.md)
176
-
177
- #### Inherited from
178
-
179
- [StormError](StormError.md).[getErrorResponse](StormError.md#geterrorresponse)
180
-
181
- #### Defined in
182
-
183
- [src/StormError.ts:76](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L76)
184
-
185
- ___
186
-
187
- ### getExitCode
188
-
189
- ▸ **getExitCode**(): [`ExitCode`](../enums/ExitCode.md)
190
-
191
- #### Returns
192
-
193
- [`ExitCode`](../enums/ExitCode.md)
194
-
195
- #### Inherited from
196
-
197
- [StormError](StormError.md).[getExitCode](StormError.md#getexitcode)
198
-
199
- #### Defined in
200
-
201
- [src/StormError.ts:97](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L97)
202
-
203
- ___
204
-
205
- ### getHTTPCode
206
-
207
- ▸ **getHTTPCode**(): [`StatusCode`](../enums/StatusCode.md)
208
-
209
- #### Returns
210
-
211
- [`StatusCode`](../enums/StatusCode.md)
212
-
213
- #### Overrides
214
-
215
- [StormError](StormError.md).[getHTTPCode](StormError.md#gethttpcode)
216
-
217
- #### Defined in
218
-
219
- [src/EntityNotFoundError.ts:34](https://github.com/breautek/storm/blob/d45307d/src/EntityNotFoundError.ts#L34)
220
-
221
- ___
222
-
223
- ### getLocaleCode
224
-
225
- ▸ **getLocaleCode**(): `string`
226
-
227
- #### Returns
228
-
229
- `string`
230
-
231
- #### Overrides
232
-
233
- [StormError](StormError.md).[getLocaleCode](StormError.md#getlocalecode)
234
-
235
- #### Defined in
236
-
237
- [src/EntityNotFoundError.ts:38](https://github.com/breautek/storm/blob/d45307d/src/EntityNotFoundError.ts#L38)
238
-
239
- ___
240
-
241
- ### getLocaleParameters
242
-
243
- ▸ **getLocaleParameters**(): `Record`<`string`, `string`\>
244
-
245
- #### Returns
246
-
247
- `Record`<`string`, `string`\>
248
-
249
- #### Overrides
250
-
251
- [StormError](StormError.md).[getLocaleParameters](StormError.md#getlocaleparameters)
252
-
253
- #### Defined in
254
-
255
- [src/EntityNotFoundError.ts:42](https://github.com/breautek/storm/blob/d45307d/src/EntityNotFoundError.ts#L42)
256
-
257
- ___
258
-
259
- ### getMessage
260
-
261
- ▸ **getMessage**(): `string`
262
-
263
- #### Returns
264
-
265
- `string`
266
-
267
- #### Overrides
268
-
269
- [StormError](StormError.md).[getMessage](StormError.md#getmessage)
270
-
271
- #### Defined in
272
-
273
- [src/EntityNotFoundError.ts:26](https://github.com/breautek/storm/blob/d45307d/src/EntityNotFoundError.ts#L26)
274
-
275
- ___
276
-
277
- ### getPrivateDetails
278
-
279
- ▸ **getPrivateDetails**(): `any`
280
-
281
- Private details are only logged to the server log.
282
- They are kept secret from the client.
283
-
284
- #### Returns
285
-
286
- `any`
287
-
288
- #### Inherited from
289
-
290
- [StormError](StormError.md).[getPrivateDetails](StormError.md#getprivatedetails)
291
-
292
- #### Defined in
293
-
294
- [src/StormError.ts:68](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L68)
295
-
296
- ___
297
-
298
- ### getPublicDetails
299
-
300
- ▸ **getPublicDetails**(): [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
301
-
302
- Sends details to the client.
303
-
304
- #### Returns
305
-
306
- [`IAdditionalErrorDetails`](../interfaces/IAdditionalErrorDetails.md)
307
-
308
- #### Inherited from
309
-
310
- [StormError](StormError.md).[getPublicDetails](StormError.md#getpublicdetails)
311
-
312
- #### Defined in
313
-
314
- [src/StormError.ts:60](https://github.com/breautek/storm/blob/d45307d/src/StormError.ts#L60)
315
-
316
- ___
317
-
318
- ### captureStackTrace
319
-
320
- ▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
321
-
322
- Create .stack property on a target object
323
-
324
- #### Parameters
325
-
326
- | Name | Type |
327
- | :------ | :------ |
328
- | `targetObject` | `object` |
329
- | `constructorOpt?` | `Function` |
330
-
331
- #### Returns
332
-
333
- `void`
334
-
335
- #### Inherited from
336
-
337
- [StormError](StormError.md).[captureStackTrace](StormError.md#capturestacktrace)
338
-
339
- #### Defined in
340
-
341
- node_modules/@types/node/globals.d.ts:4