@breautek/storm 5.0.1 → 6.0.1

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 (204) hide show
  1. package/CHANGELOG.md +24 -2
  2. package/bt-config-defaults.json +0 -1
  3. package/bt-config-sample.jsonc +41 -7
  4. package/docs/assets/highlight.css +92 -0
  5. package/docs/assets/main.js +58 -0
  6. package/docs/assets/search.js +1 -0
  7. package/docs/assets/style.css +1367 -0
  8. package/docs/classes/Application.html +1278 -0
  9. package/docs/classes/BackendAuthenticationMiddleware.html +193 -0
  10. package/docs/classes/CORSMiddleware.html +259 -0
  11. package/docs/classes/ConfigLoader.html +168 -0
  12. package/docs/classes/Database.html +342 -0
  13. package/docs/classes/DatabaseCastObject.html +205 -0
  14. package/docs/classes/DatabaseConnection.html +552 -0
  15. package/docs/classes/DatabaseQueryError.html +374 -0
  16. package/docs/classes/DeadLockError.html +374 -0
  17. package/docs/classes/DiskSpaceError.html +364 -0
  18. package/docs/classes/DropTemporaryTableQuery.html +287 -0
  19. package/docs/classes/DuplicateEntryError.html +368 -0
  20. package/docs/classes/EntityNotFoundError.html +364 -0
  21. package/docs/classes/ExpiredTokenError.html +364 -0
  22. package/docs/classes/Handler.html +397 -0
  23. package/docs/classes/InternalError.html +364 -0
  24. package/docs/classes/InvalidCredentialsError.html +364 -0
  25. package/docs/classes/InvalidValueError.html +375 -0
  26. package/docs/classes/LineString.html +214 -0
  27. package/docs/classes/LockWaitTimeoutError.html +374 -0
  28. package/docs/classes/ManagedDatabaseConnection.html +412 -0
  29. package/docs/classes/Middleware.html +204 -0
  30. package/docs/classes/MissingConfigError.html +364 -0
  31. package/docs/classes/MissingParameterError.html +364 -0
  32. package/docs/classes/MySQLConnection.html +548 -0
  33. package/docs/classes/MySQLDatabase.html +355 -0
  34. package/docs/classes/NotImplementedError.html +364 -0
  35. package/docs/classes/Point.html +216 -0
  36. package/docs/classes/Polygon.html +214 -0
  37. package/docs/classes/Query.html +314 -0
  38. package/docs/classes/RawError.html +376 -0
  39. package/docs/classes/RawQuery.html +307 -0
  40. package/docs/classes/Request.html +377 -0
  41. package/docs/classes/Response.html +331 -0
  42. package/docs/classes/ResponseData.html +257 -0
  43. package/docs/classes/ServiceProvider.html +387 -0
  44. package/docs/classes/ServiceResponse.html +215 -0
  45. package/docs/classes/SetSessionVariableQuery.html +287 -0
  46. package/docs/classes/StormError.html +379 -0
  47. package/docs/classes/TemporaryTableQuery.html +292 -0
  48. package/docs/classes/Token.html +183 -0
  49. package/docs/classes/TokenManager.html +235 -0
  50. package/docs/classes/Transaction.html +269 -0
  51. package/docs/classes/UnauthorizedAccessError.html +364 -0
  52. package/docs/enums/ErrorCode.html +212 -0
  53. package/docs/enums/ExitCode.html +163 -0
  54. package/docs/enums/HTTPMethod.html +177 -0
  55. package/docs/enums/IsolationLevel.html +177 -0
  56. package/docs/enums/JWTError.html +163 -0
  57. package/docs/enums/StatusCode.html +485 -0
  58. package/docs/functions/formidable-1.html +145 -0
  59. package/docs/functions/getInstance.html +140 -0
  60. package/docs/index.html +228 -0
  61. package/docs/interfaces/IAdditionalErrorDetails.html +142 -0
  62. package/docs/interfaces/IAuthTokenData.html +174 -0
  63. package/docs/interfaces/ICloudwatchConfig.html +174 -0
  64. package/docs/interfaces/ICloudwatchCredentials.html +167 -0
  65. package/docs/interfaces/ICloudwatchStreamConfig.html +167 -0
  66. package/docs/interfaces/IConfig.html +227 -0
  67. package/docs/interfaces/IDatabaseConfig.html +200 -0
  68. package/docs/interfaces/IDatabaseConnection.html +334 -0
  69. package/docs/interfaces/IErrorResponse.html +188 -0
  70. package/docs/interfaces/IFormData.html +167 -0
  71. package/docs/interfaces/IHandler.html +173 -0
  72. package/docs/interfaces/IInsertQueryResult.html +174 -0
  73. package/docs/interfaces/IJWTVerifyOptions.html +160 -0
  74. package/docs/interfaces/IParameterMap.html +142 -0
  75. package/docs/interfaces/IQueryable.html +235 -0
  76. package/docs/interfaces/IRequestResponse.html +174 -0
  77. package/docs/interfaces/IServiceHeaders.html +142 -0
  78. package/docs/interfaces/ISetSessionVariableQueryInput.html +167 -0
  79. package/docs/interfaces/ITemporaryTableQueryInput.html +167 -0
  80. package/docs/interfaces/IUpdateQueryResult.html +167 -0
  81. package/docs/interfaces/formidable.EmitData.html +182 -0
  82. package/docs/interfaces/formidable.EventData.html +203 -0
  83. package/docs/interfaces/formidable.Fields.html +143 -0
  84. package/docs/interfaces/formidable.File.html +241 -0
  85. package/docs/interfaces/formidable.FileJSON.html +240 -0
  86. package/docs/interfaces/formidable.Files.html +143 -0
  87. package/docs/interfaces/formidable.Options.html +310 -0
  88. package/docs/interfaces/formidable.Part.html +693 -0
  89. package/docs/modules/formidable.html +161 -0
  90. package/docs/types/IDeleteQueryResult.html +136 -0
  91. package/docs/types/IHandlerError.html +141 -0
  92. package/docs/types/IHandlerResponse.html +147 -0
  93. package/docs/types/TCoordinate.html +136 -0
  94. package/docs/types/formidable.BufferEncoding.html +137 -0
  95. package/docs/types/formidable.DefaultOptions.html +137 -0
  96. package/docs/types/formidable.EnabledPlugins.html +137 -0
  97. package/docs/types/formidable.EventNames.html +137 -0
  98. package/docs/types/formidable.MappedParsers.html +137 -0
  99. package/docs/types/formidable.Plugin.html +137 -0
  100. package/docs/types/formidable.PluginFunction.html +152 -0
  101. package/docs/types/formidable.Plugins.html +137 -0
  102. package/lib/Application.d.ts +3 -0
  103. package/lib/Application.js +105 -63
  104. package/lib/Application.js.map +1 -1
  105. package/lib/IConfig.d.ts +15 -2
  106. package/lib/MySQLConnection.js +3 -3
  107. package/lib/MySQLConnection.js.map +1 -1
  108. package/lib/StatusCode.d.ts +1 -1
  109. package/lib/StatusCode.js +1 -1
  110. package/lib/Transaction.d.ts +4 -0
  111. package/lib/Transaction.js +4 -0
  112. package/lib/Transaction.js.map +1 -1
  113. package/lib/api.d.ts +1 -2
  114. package/lib/api.js +2 -4
  115. package/lib/api.js.map +1 -1
  116. package/package.json +18 -16
  117. package/src/Application.ts +131 -68
  118. package/src/IConfig.ts +18 -2
  119. package/src/MySQLConnection.ts +2 -1
  120. package/src/StatusCode.ts +1 -1
  121. package/src/Transaction.ts +4 -0
  122. package/src/api.ts +6 -2
  123. package/docs/README.md +0 -188
  124. package/docs/classes/Application.md +0 -1648
  125. package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
  126. package/docs/classes/CORSMiddleware.md +0 -143
  127. package/docs/classes/ConfigLoader.md +0 -29
  128. package/docs/classes/Database.md +0 -259
  129. package/docs/classes/DatabaseCastObject.md +0 -79
  130. package/docs/classes/DatabaseConnection.md +0 -556
  131. package/docs/classes/DatabaseQueryError.md +0 -351
  132. package/docs/classes/DeadLockError.md +0 -349
  133. package/docs/classes/DiskSpaceError.md +0 -341
  134. package/docs/classes/DropTemporaryTableQuery.md +0 -207
  135. package/docs/classes/DumpStream.md +0 -23
  136. package/docs/classes/DuplicateEntryError.md +0 -343
  137. package/docs/classes/EntityNotFoundError.md +0 -341
  138. package/docs/classes/ExpiredTokenError.md +0 -341
  139. package/docs/classes/Handler.md +0 -302
  140. package/docs/classes/InternalError.md +0 -341
  141. package/docs/classes/InvalidCredentialsError.md +0 -341
  142. package/docs/classes/InvalidValueError.md +0 -349
  143. package/docs/classes/LineString.md +0 -101
  144. package/docs/classes/LockWaitTimeoutError.md +0 -349
  145. package/docs/classes/ManagedDatabaseConnection.md +0 -403
  146. package/docs/classes/Middleware.md +0 -72
  147. package/docs/classes/MissingConfigError.md +0 -341
  148. package/docs/classes/MissingParameterError.md +0 -341
  149. package/docs/classes/MySQLConnection.md +0 -569
  150. package/docs/classes/MySQLDatabase.md +0 -314
  151. package/docs/classes/NotImplementedError.md +0 -341
  152. package/docs/classes/Point.md +0 -102
  153. package/docs/classes/Polygon.md +0 -101
  154. package/docs/classes/Query.md +0 -227
  155. package/docs/classes/RawError.md +0 -351
  156. package/docs/classes/RawQuery.md +0 -224
  157. package/docs/classes/Request.md +0 -321
  158. package/docs/classes/Response.md +0 -242
  159. package/docs/classes/ResponseData.md +0 -144
  160. package/docs/classes/ServiceProvider.md +0 -296
  161. package/docs/classes/ServiceResponse.md +0 -89
  162. package/docs/classes/SetSessionVariableQuery.md +0 -207
  163. package/docs/classes/StormError.md +0 -343
  164. package/docs/classes/TemporaryTableQuery.md +0 -213
  165. package/docs/classes/Token.md +0 -43
  166. package/docs/classes/TokenManager.md +0 -105
  167. package/docs/classes/Transaction.md +0 -161
  168. package/docs/classes/UnauthorizedAccessError.md +0 -341
  169. package/docs/enums/ErrorCode.md +0 -107
  170. package/docs/enums/ExitCode.md +0 -30
  171. package/docs/enums/HTTPMethod.md +0 -52
  172. package/docs/enums/IsolationLevel.md +0 -52
  173. package/docs/enums/JWTError.md +0 -30
  174. package/docs/enums/StatusCode.md +0 -536
  175. package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
  176. package/docs/interfaces/IAuthTokenData.md +0 -41
  177. package/docs/interfaces/IConfig.md +0 -112
  178. package/docs/interfaces/IDatabaseConfig.md +0 -80
  179. package/docs/interfaces/IDatabaseConnection.md +0 -262
  180. package/docs/interfaces/IErrorResponse.md +0 -63
  181. package/docs/interfaces/IFormData.md +0 -30
  182. package/docs/interfaces/IHandler.md +0 -31
  183. package/docs/interfaces/IInsertQueryResult.md +0 -41
  184. package/docs/interfaces/IJWTVerifyOptions.md +0 -19
  185. package/docs/interfaces/IParameterMap.md +0 -7
  186. package/docs/interfaces/IQueryable.md +0 -119
  187. package/docs/interfaces/IRequestResponse.md +0 -37
  188. package/docs/interfaces/IServiceHeaders.md +0 -7
  189. package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
  190. package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
  191. package/docs/interfaces/IUpdateQueryResult.md +0 -30
  192. package/docs/interfaces/formidable.EmitData.md +0 -54
  193. package/docs/interfaces/formidable.EventData.md +0 -87
  194. package/docs/interfaces/formidable.Fields.md +0 -9
  195. package/docs/interfaces/formidable.File.md +0 -131
  196. package/docs/interfaces/formidable.FileJSON.md +0 -151
  197. package/docs/interfaces/formidable.Files.md +0 -9
  198. package/docs/interfaces/formidable.Options.md +0 -225
  199. package/docs/interfaces/formidable.Part.md +0 -793
  200. package/docs/modules/formidable.md +0 -122
  201. package/lib/DumpStream.d.ts +0 -6
  202. package/lib/DumpStream.js +0 -28
  203. package/lib/DumpStream.js.map +0 -1
  204. package/src/DumpStream.ts +0 -28
@@ -1,321 +0,0 @@
1
- [@breautek/storm](../README.md) / Request
2
-
3
- # Class: Request<TBody, TAuthToken\>
4
-
5
- ## Type parameters
6
-
7
- | Name | Type |
8
- | :------ | :------ |
9
- | `TBody` | `any` |
10
- | `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
11
-
12
- ## Table of contents
13
-
14
- ### Constructors
15
-
16
- - [constructor](Request.md#constructor)
17
-
18
- ### Methods
19
-
20
- - [getAuthenticationToken](Request.md#getauthenticationtoken)
21
- - [getBody](Request.md#getbody)
22
- - [getForm](Request.md#getform)
23
- - [getForwardedIP](Request.md#getforwardedip)
24
- - [getHeader](Request.md#getheader)
25
- - [getHeaders](Request.md#getheaders)
26
- - [getHostname](Request.md#gethostname)
27
- - [getIP](Request.md#getip)
28
- - [getMethod](Request.md#getmethod)
29
- - [getParam](Request.md#getparam)
30
- - [getParams](Request.md#getparams)
31
- - [getQueryVariables](Request.md#getqueryvariables)
32
- - [getRequestSource](Request.md#getrequestsource)
33
- - [getURL](Request.md#geturl)
34
- - [isSecure](Request.md#issecure)
35
- - [pipe](Request.md#pipe)
36
- - [unpipe](Request.md#unpipe)
37
-
38
- ## Constructors
39
-
40
- ### constructor
41
-
42
- • **new Request**<`TBody`, `TAuthToken`\>(`request`)
43
-
44
- #### Type parameters
45
-
46
- | Name | Type |
47
- | :------ | :------ |
48
- | `TBody` | `any` |
49
- | `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
50
-
51
- #### Parameters
52
-
53
- | Name | Type |
54
- | :------ | :------ |
55
- | `request` | `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> |
56
-
57
- #### Defined in
58
-
59
- [src/Request.ts:42](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L42)
60
-
61
- ## Methods
62
-
63
- ### getAuthenticationToken
64
-
65
- ▸ **getAuthenticationToken**(): `Promise`<`TAuthToken`\>
66
-
67
- #### Returns
68
-
69
- `Promise`<`TAuthToken`\>
70
-
71
- #### Defined in
72
-
73
- [src/Request.ts:132](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L132)
74
-
75
- ___
76
-
77
- ### getBody
78
-
79
- ▸ **getBody**(): `TBody`
80
-
81
- #### Returns
82
-
83
- `TBody`
84
-
85
- #### Defined in
86
-
87
- [src/Request.ts:46](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L46)
88
-
89
- ___
90
-
91
- ### getForm
92
-
93
- ▸ **getForm**(): `Promise`<[`IFormData`](../interfaces/IFormData.md)\>
94
-
95
- #### Returns
96
-
97
- `Promise`<[`IFormData`](../interfaces/IFormData.md)\>
98
-
99
- #### Defined in
100
-
101
- [src/Request.ts:50](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L50)
102
-
103
- ___
104
-
105
- ### getForwardedIP
106
-
107
- ▸ **getForwardedIP**(): `string`
108
-
109
- #### Returns
110
-
111
- `string`
112
-
113
- #### Defined in
114
-
115
- [src/Request.ts:100](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L100)
116
-
117
- ___
118
-
119
- ### getHeader
120
-
121
- ▸ **getHeader**(`name`): `string`
122
-
123
- #### Parameters
124
-
125
- | Name | Type |
126
- | :------ | :------ |
127
- | `name` | `string` |
128
-
129
- #### Returns
130
-
131
- `string`
132
-
133
- #### Defined in
134
-
135
- [src/Request.ts:74](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L74)
136
-
137
- ___
138
-
139
- ### getHeaders
140
-
141
- ▸ **getHeaders**(): `IncomingHttpHeaders`
142
-
143
- #### Returns
144
-
145
- `IncomingHttpHeaders`
146
-
147
- #### Defined in
148
-
149
- [src/Request.ts:70](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L70)
150
-
151
- ___
152
-
153
- ### getHostname
154
-
155
- ▸ **getHostname**(): `string`
156
-
157
- #### Returns
158
-
159
- `string`
160
-
161
- #### Defined in
162
-
163
- [src/Request.ts:104](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L104)
164
-
165
- ___
166
-
167
- ### getIP
168
-
169
- ▸ **getIP**(): `string`
170
-
171
- #### Returns
172
-
173
- `string`
174
-
175
- #### Defined in
176
-
177
- [src/Request.ts:96](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L96)
178
-
179
- ___
180
-
181
- ### getMethod
182
-
183
- ▸ **getMethod**(): `string`
184
-
185
- #### Returns
186
-
187
- `string`
188
-
189
- #### Defined in
190
-
191
- [src/Request.ts:108](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L108)
192
-
193
- ___
194
-
195
- ### getParam
196
-
197
- ▸ **getParam**(`name`): `string`
198
-
199
- #### Parameters
200
-
201
- | Name | Type |
202
- | :------ | :------ |
203
- | `name` | `string` |
204
-
205
- #### Returns
206
-
207
- `string`
208
-
209
- #### Defined in
210
-
211
- [src/Request.ts:92](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L92)
212
-
213
- ___
214
-
215
- ### getParams
216
-
217
- ▸ **getParams**(): [`IParameterMap`](../interfaces/IParameterMap.md)
218
-
219
- #### Returns
220
-
221
- [`IParameterMap`](../interfaces/IParameterMap.md)
222
-
223
- #### Defined in
224
-
225
- [src/Request.ts:88](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L88)
226
-
227
- ___
228
-
229
- ### getQueryVariables
230
-
231
- ▸ **getQueryVariables**(): `any`
232
-
233
- #### Returns
234
-
235
- `any`
236
-
237
- #### Defined in
238
-
239
- [src/Request.ts:84](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L84)
240
-
241
- ___
242
-
243
- ### getRequestSource
244
-
245
- ▸ **getRequestSource**(): `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>
246
-
247
- #### Returns
248
-
249
- `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>
250
-
251
- #### Defined in
252
-
253
- [src/Request.ts:128](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L128)
254
-
255
- ___
256
-
257
- ### getURL
258
-
259
- ▸ **getURL**(): `string`
260
-
261
- #### Returns
262
-
263
- `string`
264
-
265
- #### Defined in
266
-
267
- [src/Request.ts:112](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L112)
268
-
269
- ___
270
-
271
- ### isSecure
272
-
273
- ▸ **isSecure**(): `boolean`
274
-
275
- #### Returns
276
-
277
- `boolean`
278
-
279
- #### Defined in
280
-
281
- [src/Request.ts:116](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L116)
282
-
283
- ___
284
-
285
- ### pipe
286
-
287
- ▸ **pipe**(`destination`): `any`
288
-
289
- #### Parameters
290
-
291
- | Name | Type |
292
- | :------ | :------ |
293
- | `destination` | `Writable` |
294
-
295
- #### Returns
296
-
297
- `any`
298
-
299
- #### Defined in
300
-
301
- [src/Request.ts:120](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L120)
302
-
303
- ___
304
-
305
- ### unpipe
306
-
307
- ▸ **unpipe**(`source`): `void`
308
-
309
- #### Parameters
310
-
311
- | Name | Type |
312
- | :------ | :------ |
313
- | `source` | `Writable` |
314
-
315
- #### Returns
316
-
317
- `void`
318
-
319
- #### Defined in
320
-
321
- [src/Request.ts:124](https://github.com/breautek/storm/blob/3dcafe4/src/Request.ts#L124)
@@ -1,242 +0,0 @@
1
- [@breautek/storm](../README.md) / Response
2
-
3
- # Class: Response<TResponse, TErrorResponse\>
4
-
5
- ## Type parameters
6
-
7
- | Name | Type |
8
- | :------ | :------ |
9
- | `TResponse` | `SendableData` |
10
- | `TErrorResponse` | `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md) \| `string` |
11
-
12
- ## Table of contents
13
-
14
- ### Constructors
15
-
16
- - [constructor](Response.md#constructor)
17
-
18
- ### Methods
19
-
20
- - [error](Response.md#error)
21
- - [getStatus](Response.md#getstatus)
22
- - [isHeadersSent](Response.md#isheaderssent)
23
- - [pipe](Response.md#pipe)
24
- - [redirect](Response.md#redirect)
25
- - [send](Response.md#send)
26
- - [setHeader](Response.md#setheader)
27
- - [setHeaders](Response.md#setheaders)
28
- - [setStatus](Response.md#setstatus)
29
- - [success](Response.md#success)
30
-
31
- ## Constructors
32
-
33
- ### constructor
34
-
35
- • **new Response**<`TResponse`, `TErrorResponse`\>(`response`, `requestURL`)
36
-
37
- #### Type parameters
38
-
39
- | Name | Type |
40
- | :------ | :------ |
41
- | `TResponse` | `any` |
42
- | `TErrorResponse` | `string` \| `Error` \| [`IErrorResponse`](../interfaces/IErrorResponse.md) |
43
-
44
- #### Parameters
45
-
46
- | Name | Type |
47
- | :------ | :------ |
48
- | `response` | `Response`<`any`, `Record`<`string`, `any`\>\> |
49
- | `requestURL` | `string` |
50
-
51
- #### Defined in
52
-
53
- [src/Response.ts:38](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L38)
54
-
55
- ## Methods
56
-
57
- ### error
58
-
59
- ▸ **error**(`error?`): `void`
60
-
61
- #### Parameters
62
-
63
- | Name | Type |
64
- | :------ | :------ |
65
- | `error?` | `TErrorResponse` \| [`ResponseData`](ResponseData.md)<`TErrorResponse`\> |
66
-
67
- #### Returns
68
-
69
- `void`
70
-
71
- #### Defined in
72
-
73
- [src/Response.ts:131](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L131)
74
-
75
- ___
76
-
77
- ### getStatus
78
-
79
- ▸ **getStatus**(): [`StatusCode`](../enums/StatusCode.md)
80
-
81
- #### Returns
82
-
83
- [`StatusCode`](../enums/StatusCode.md)
84
-
85
- #### Defined in
86
-
87
- [src/Response.ts:49](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L49)
88
-
89
- ___
90
-
91
- ### isHeadersSent
92
-
93
- ▸ **isHeadersSent**(): `boolean`
94
-
95
- #### Returns
96
-
97
- `boolean`
98
-
99
- #### Defined in
100
-
101
- [src/Response.ts:127](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L127)
102
-
103
- ___
104
-
105
- ### pipe
106
-
107
- ▸ **pipe**(`stream`): `void`
108
-
109
- #### Parameters
110
-
111
- | Name | Type |
112
- | :------ | :------ |
113
- | `stream` | `ReadableStream` |
114
-
115
- #### Returns
116
-
117
- `void`
118
-
119
- #### Defined in
120
-
121
- [src/Response.ts:100](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L100)
122
-
123
- ___
124
-
125
- ### redirect
126
-
127
- ▸ **redirect**(`url`): `void`
128
-
129
- #### Parameters
130
-
131
- | Name | Type |
132
- | :------ | :------ |
133
- | `url` | `string` |
134
-
135
- #### Returns
136
-
137
- `void`
138
-
139
- #### Defined in
140
-
141
- [src/Response.ts:53](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L53)
142
-
143
- ___
144
-
145
- ### send
146
-
147
- ▸ **send**(`data?`): `void`
148
-
149
- #### Parameters
150
-
151
- | Name | Type |
152
- | :------ | :------ |
153
- | `data?` | `Buffer` \| [`IErrorResponse`](../interfaces/IErrorResponse.md) \| [`StormError`](StormError.md)<`any`\> \| `TResponse` \| `TErrorResponse` |
154
-
155
- #### Returns
156
-
157
- `void`
158
-
159
- #### Defined in
160
-
161
- [src/Response.ts:95](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L95)
162
-
163
- ___
164
-
165
- ### setHeader
166
-
167
- ▸ **setHeader**(`key`, `value`): `void`
168
-
169
- #### Parameters
170
-
171
- | Name | Type |
172
- | :------ | :------ |
173
- | `key` | `string` |
174
- | `value` | `string` |
175
-
176
- #### Returns
177
-
178
- `void`
179
-
180
- #### Defined in
181
-
182
- [src/Response.ts:119](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L119)
183
-
184
- ___
185
-
186
- ### setHeaders
187
-
188
- ▸ **setHeaders**(`keyValuePair`): `void`
189
-
190
- #### Parameters
191
-
192
- | Name | Type |
193
- | :------ | :------ |
194
- | `keyValuePair` | `IHeaderKeyValuePair` |
195
-
196
- #### Returns
197
-
198
- `void`
199
-
200
- #### Defined in
201
-
202
- [src/Response.ts:123](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L123)
203
-
204
- ___
205
-
206
- ### setStatus
207
-
208
- ▸ **setStatus**(`status`): [`Response`](Response.md)<`TResponse`, `TErrorResponse`\>
209
-
210
- #### Parameters
211
-
212
- | Name | Type |
213
- | :------ | :------ |
214
- | `status` | [`StatusCode`](../enums/StatusCode.md) |
215
-
216
- #### Returns
217
-
218
- [`Response`](Response.md)<`TResponse`, `TErrorResponse`\>
219
-
220
- #### Defined in
221
-
222
- [src/Response.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L44)
223
-
224
- ___
225
-
226
- ### success
227
-
228
- ▸ **success**(`data?`): `void`
229
-
230
- #### Parameters
231
-
232
- | Name | Type |
233
- | :------ | :------ |
234
- | `data?` | `TResponse` |
235
-
236
- #### Returns
237
-
238
- `void`
239
-
240
- #### Defined in
241
-
242
- [src/Response.ts:108](https://github.com/breautek/storm/blob/3dcafe4/src/Response.ts#L108)
@@ -1,144 +0,0 @@
1
- [@breautek/storm](../README.md) / ResponseData
2
-
3
- # Class: ResponseData<TData\>
4
-
5
- ## Type parameters
6
-
7
- | Name | Type |
8
- | :------ | :------ |
9
- | `TData` | `any` |
10
-
11
- ## Table of contents
12
-
13
- ### Constructors
14
-
15
- - [constructor](ResponseData.md#constructor)
16
-
17
- ### Methods
18
-
19
- - [getData](ResponseData.md#getdata)
20
- - [getHeaders](ResponseData.md#getheaders)
21
- - [getRedirect](ResponseData.md#getredirect)
22
- - [getStatus](ResponseData.md#getstatus)
23
- - [redirect](ResponseData.md#redirect)
24
- - [setHeader](ResponseData.md#setheader)
25
-
26
- ## Constructors
27
-
28
- ### constructor
29
-
30
- • **new ResponseData**<`TData`\>(`status`, `data?`)
31
-
32
- #### Type parameters
33
-
34
- | Name | Type |
35
- | :------ | :------ |
36
- | `TData` | `any` |
37
-
38
- #### Parameters
39
-
40
- | Name | Type |
41
- | :------ | :------ |
42
- | `status` | [`StatusCode`](../enums/StatusCode.md) |
43
- | `data?` | `TData` |
44
-
45
- #### Defined in
46
-
47
- [src/ResponseData.ts:25](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L25)
48
-
49
- ## Methods
50
-
51
- ### getData
52
-
53
- ▸ **getData**(): `TData`
54
-
55
- #### Returns
56
-
57
- `TData`
58
-
59
- #### Defined in
60
-
61
- [src/ResponseData.ts:44](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L44)
62
-
63
- ___
64
-
65
- ### getHeaders
66
-
67
- ▸ **getHeaders**(): `Map`<`string`, `string`\>
68
-
69
- #### Returns
70
-
71
- `Map`<`string`, `string`\>
72
-
73
- #### Defined in
74
-
75
- [src/ResponseData.ts:36](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L36)
76
-
77
- ___
78
-
79
- ### getRedirect
80
-
81
- ▸ **getRedirect**(): `string`
82
-
83
- #### Returns
84
-
85
- `string`
86
-
87
- #### Defined in
88
-
89
- [src/ResponseData.ts:52](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L52)
90
-
91
- ___
92
-
93
- ### getStatus
94
-
95
- ▸ **getStatus**(): [`StatusCode`](../enums/StatusCode.md)
96
-
97
- #### Returns
98
-
99
- [`StatusCode`](../enums/StatusCode.md)
100
-
101
- #### Defined in
102
-
103
- [src/ResponseData.ts:40](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L40)
104
-
105
- ___
106
-
107
- ### redirect
108
-
109
- ▸ **redirect**(`url`): `void`
110
-
111
- #### Parameters
112
-
113
- | Name | Type |
114
- | :------ | :------ |
115
- | `url` | `string` |
116
-
117
- #### Returns
118
-
119
- `void`
120
-
121
- #### Defined in
122
-
123
- [src/ResponseData.ts:48](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L48)
124
-
125
- ___
126
-
127
- ### setHeader
128
-
129
- ▸ **setHeader**(`name`, `value`): `void`
130
-
131
- #### Parameters
132
-
133
- | Name | Type |
134
- | :------ | :------ |
135
- | `name` | `string` |
136
- | `value` | `string` |
137
-
138
- #### Returns
139
-
140
- `void`
141
-
142
- #### Defined in
143
-
144
- [src/ResponseData.ts:32](https://github.com/breautek/storm/blob/3dcafe4/src/ResponseData.ts#L32)