@breautek/storm 5.0.1 → 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.
- package/CHANGELOG.md +10 -2
- package/docs/assets/highlight.css +85 -0
- package/docs/assets/main.js +58 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1367 -0
- package/docs/classes/Application.html +1235 -0
- package/docs/classes/BackendAuthenticationMiddleware.html +191 -0
- package/docs/classes/CORSMiddleware.html +257 -0
- package/docs/classes/ConfigLoader.html +166 -0
- package/docs/classes/Database.html +340 -0
- package/docs/classes/DatabaseCastObject.html +203 -0
- package/docs/classes/DatabaseConnection.html +550 -0
- package/docs/classes/DatabaseQueryError.html +372 -0
- package/docs/classes/DeadLockError.html +372 -0
- package/docs/classes/DiskSpaceError.html +362 -0
- package/docs/classes/DropTemporaryTableQuery.html +285 -0
- package/docs/classes/DumpStream.html +161 -0
- package/docs/classes/DuplicateEntryError.html +366 -0
- package/docs/classes/EntityNotFoundError.html +362 -0
- package/docs/classes/ExpiredTokenError.html +362 -0
- package/docs/classes/Handler.html +395 -0
- package/docs/classes/InternalError.html +362 -0
- package/docs/classes/InvalidCredentialsError.html +362 -0
- package/docs/classes/InvalidValueError.html +373 -0
- package/docs/classes/LineString.html +212 -0
- package/docs/classes/LockWaitTimeoutError.html +372 -0
- package/docs/classes/ManagedDatabaseConnection.html +410 -0
- package/docs/classes/Middleware.html +202 -0
- package/docs/classes/MissingConfigError.html +362 -0
- package/docs/classes/MissingParameterError.html +362 -0
- package/docs/classes/MySQLConnection.html +546 -0
- package/docs/classes/MySQLDatabase.html +353 -0
- package/docs/classes/NotImplementedError.html +362 -0
- package/docs/classes/Point.html +214 -0
- package/docs/classes/Polygon.html +212 -0
- package/docs/classes/Query.html +312 -0
- package/docs/classes/RawError.html +374 -0
- package/docs/classes/RawQuery.html +305 -0
- package/docs/classes/Request.html +375 -0
- package/docs/classes/Response.html +329 -0
- package/docs/classes/ResponseData.html +255 -0
- package/docs/classes/ServiceProvider.html +385 -0
- package/docs/classes/ServiceResponse.html +213 -0
- package/docs/classes/SetSessionVariableQuery.html +285 -0
- package/docs/classes/StormError.html +377 -0
- package/docs/classes/TemporaryTableQuery.html +290 -0
- package/docs/classes/Token.html +181 -0
- package/docs/classes/TokenManager.html +233 -0
- package/docs/classes/Transaction.html +267 -0
- package/docs/classes/UnauthorizedAccessError.html +362 -0
- package/docs/enums/ErrorCode.html +210 -0
- package/docs/enums/ExitCode.html +161 -0
- package/docs/enums/HTTPMethod.html +175 -0
- package/docs/enums/IsolationLevel.html +175 -0
- package/docs/enums/JWTError.html +161 -0
- package/docs/enums/StatusCode.html +483 -0
- package/docs/functions/formidable-1.html +143 -0
- package/docs/functions/getInstance.html +138 -0
- package/docs/index.html +224 -0
- package/docs/interfaces/IAdditionalErrorDetails.html +140 -0
- package/docs/interfaces/IAuthTokenData.html +172 -0
- package/docs/interfaces/IConfig.html +225 -0
- package/docs/interfaces/IDatabaseConfig.html +198 -0
- package/docs/interfaces/IDatabaseConnection.html +332 -0
- package/docs/interfaces/IErrorResponse.html +186 -0
- package/docs/interfaces/IFormData.html +165 -0
- package/docs/interfaces/IHandler.html +171 -0
- package/docs/interfaces/IInsertQueryResult.html +172 -0
- package/docs/interfaces/IJWTVerifyOptions.html +158 -0
- package/docs/interfaces/IParameterMap.html +140 -0
- package/docs/interfaces/IQueryable.html +233 -0
- package/docs/interfaces/IRequestResponse.html +172 -0
- package/docs/interfaces/IServiceHeaders.html +140 -0
- package/docs/interfaces/ISetSessionVariableQueryInput.html +165 -0
- package/docs/interfaces/ITemporaryTableQueryInput.html +165 -0
- package/docs/interfaces/IUpdateQueryResult.html +165 -0
- package/docs/interfaces/formidable.EmitData.html +180 -0
- package/docs/interfaces/formidable.EventData.html +201 -0
- package/docs/interfaces/formidable.Fields.html +141 -0
- package/docs/interfaces/formidable.File.html +239 -0
- package/docs/interfaces/formidable.FileJSON.html +238 -0
- package/docs/interfaces/formidable.Files.html +141 -0
- package/docs/interfaces/formidable.Options.html +308 -0
- package/docs/interfaces/formidable.Part.html +691 -0
- package/docs/modules/formidable.html +159 -0
- package/docs/types/IDeleteQueryResult.html +134 -0
- package/docs/types/IHandlerError.html +139 -0
- package/docs/types/IHandlerResponse.html +145 -0
- package/docs/types/TCoordinate.html +134 -0
- package/docs/types/formidable.BufferEncoding.html +135 -0
- package/docs/types/formidable.DefaultOptions.html +135 -0
- package/docs/types/formidable.EnabledPlugins.html +135 -0
- package/docs/types/formidable.EventNames.html +135 -0
- package/docs/types/formidable.MappedParsers.html +135 -0
- package/docs/types/formidable.Plugin.html +135 -0
- package/docs/types/formidable.PluginFunction.html +150 -0
- package/docs/types/formidable.Plugins.html +135 -0
- package/lib/StatusCode.d.ts +1 -1
- package/lib/StatusCode.js +1 -1
- package/lib/Transaction.d.ts +4 -0
- package/lib/Transaction.js +4 -0
- package/lib/Transaction.js.map +1 -1
- package/package.json +14 -14
- package/src/StatusCode.ts +1 -1
- package/src/Transaction.ts +4 -0
- package/docs/README.md +0 -188
- package/docs/classes/Application.md +0 -1648
- package/docs/classes/BackendAuthenticationMiddleware.md +0 -49
- package/docs/classes/CORSMiddleware.md +0 -143
- package/docs/classes/ConfigLoader.md +0 -29
- package/docs/classes/Database.md +0 -259
- package/docs/classes/DatabaseCastObject.md +0 -79
- package/docs/classes/DatabaseConnection.md +0 -556
- package/docs/classes/DatabaseQueryError.md +0 -351
- package/docs/classes/DeadLockError.md +0 -349
- package/docs/classes/DiskSpaceError.md +0 -341
- package/docs/classes/DropTemporaryTableQuery.md +0 -207
- package/docs/classes/DumpStream.md +0 -23
- package/docs/classes/DuplicateEntryError.md +0 -343
- package/docs/classes/EntityNotFoundError.md +0 -341
- package/docs/classes/ExpiredTokenError.md +0 -341
- package/docs/classes/Handler.md +0 -302
- package/docs/classes/InternalError.md +0 -341
- package/docs/classes/InvalidCredentialsError.md +0 -341
- package/docs/classes/InvalidValueError.md +0 -349
- package/docs/classes/LineString.md +0 -101
- package/docs/classes/LockWaitTimeoutError.md +0 -349
- package/docs/classes/ManagedDatabaseConnection.md +0 -403
- package/docs/classes/Middleware.md +0 -72
- package/docs/classes/MissingConfigError.md +0 -341
- package/docs/classes/MissingParameterError.md +0 -341
- package/docs/classes/MySQLConnection.md +0 -569
- package/docs/classes/MySQLDatabase.md +0 -314
- package/docs/classes/NotImplementedError.md +0 -341
- package/docs/classes/Point.md +0 -102
- package/docs/classes/Polygon.md +0 -101
- package/docs/classes/Query.md +0 -227
- package/docs/classes/RawError.md +0 -351
- package/docs/classes/RawQuery.md +0 -224
- package/docs/classes/Request.md +0 -321
- package/docs/classes/Response.md +0 -242
- package/docs/classes/ResponseData.md +0 -144
- package/docs/classes/ServiceProvider.md +0 -296
- package/docs/classes/ServiceResponse.md +0 -89
- package/docs/classes/SetSessionVariableQuery.md +0 -207
- package/docs/classes/StormError.md +0 -343
- package/docs/classes/TemporaryTableQuery.md +0 -213
- package/docs/classes/Token.md +0 -43
- package/docs/classes/TokenManager.md +0 -105
- package/docs/classes/Transaction.md +0 -161
- package/docs/classes/UnauthorizedAccessError.md +0 -341
- package/docs/enums/ErrorCode.md +0 -107
- package/docs/enums/ExitCode.md +0 -30
- package/docs/enums/HTTPMethod.md +0 -52
- package/docs/enums/IsolationLevel.md +0 -52
- package/docs/enums/JWTError.md +0 -30
- package/docs/enums/StatusCode.md +0 -536
- package/docs/interfaces/IAdditionalErrorDetails.md +0 -7
- package/docs/interfaces/IAuthTokenData.md +0 -41
- package/docs/interfaces/IConfig.md +0 -112
- package/docs/interfaces/IDatabaseConfig.md +0 -80
- package/docs/interfaces/IDatabaseConnection.md +0 -262
- package/docs/interfaces/IErrorResponse.md +0 -63
- package/docs/interfaces/IFormData.md +0 -30
- package/docs/interfaces/IHandler.md +0 -31
- package/docs/interfaces/IInsertQueryResult.md +0 -41
- package/docs/interfaces/IJWTVerifyOptions.md +0 -19
- package/docs/interfaces/IParameterMap.md +0 -7
- package/docs/interfaces/IQueryable.md +0 -119
- package/docs/interfaces/IRequestResponse.md +0 -37
- package/docs/interfaces/IServiceHeaders.md +0 -7
- package/docs/interfaces/ISetSessionVariableQueryInput.md +0 -30
- package/docs/interfaces/ITemporaryTableQueryInput.md +0 -30
- package/docs/interfaces/IUpdateQueryResult.md +0 -30
- package/docs/interfaces/formidable.EmitData.md +0 -54
- package/docs/interfaces/formidable.EventData.md +0 -87
- package/docs/interfaces/formidable.Fields.md +0 -9
- package/docs/interfaces/formidable.File.md +0 -131
- package/docs/interfaces/formidable.FileJSON.md +0 -151
- package/docs/interfaces/formidable.Files.md +0 -9
- package/docs/interfaces/formidable.Options.md +0 -225
- package/docs/interfaces/formidable.Part.md +0 -793
- package/docs/modules/formidable.md +0 -122
package/docs/classes/Request.md
DELETED
|
@@ -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)
|
package/docs/classes/Response.md
DELETED
|
@@ -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)
|