@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,119 +0,0 @@
1
- [@breautek/storm](../README.md) / IQueryable
2
-
3
- # Interface: IQueryable<T\>
4
-
5
- ## Type parameters
6
-
7
- | Name |
8
- | :------ |
9
- | `T` |
10
-
11
- ## Implemented by
12
-
13
- - [`Query`](../classes/Query.md)
14
- - [`Transaction`](../classes/Transaction.md)
15
-
16
- ## Table of contents
17
-
18
- ### Methods
19
-
20
- - [execute](IQueryable.md#execute)
21
- - [getParametersForQuery](IQueryable.md#getparametersforquery)
22
- - [getQuery](IQueryable.md#getquery)
23
- - [onPostProcess](IQueryable.md#onpostprocess)
24
- - [onPreQuery](IQueryable.md#onprequery)
25
-
26
- ## Methods
27
-
28
- ### execute
29
-
30
- ▸ **execute**(`connection`): `Promise`<`T`\>
31
-
32
- #### Parameters
33
-
34
- | Name | Type |
35
- | :------ | :------ |
36
- | `connection` | [`IDatabaseConnection`](IDatabaseConnection.md) |
37
-
38
- #### Returns
39
-
40
- `Promise`<`T`\>
41
-
42
- #### Defined in
43
-
44
- [src/IQueryable.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/IQueryable.ts#L22)
45
-
46
- ___
47
-
48
- ### getParametersForQuery
49
-
50
- ▸ **getParametersForQuery**(): `Record`<`string`, `any`\>
51
-
52
- #### Returns
53
-
54
- `Record`<`string`, `any`\>
55
-
56
- #### Defined in
57
-
58
- [src/IQueryable.ts:23](https://github.com/breautek/storm/blob/3dcafe4/src/IQueryable.ts#L23)
59
-
60
- ___
61
-
62
- ### getQuery
63
-
64
- ▸ **getQuery**(`connection`): `string`
65
-
66
- #### Parameters
67
-
68
- | Name | Type |
69
- | :------ | :------ |
70
- | `connection` | [`IDatabaseConnection`](IDatabaseConnection.md) |
71
-
72
- #### Returns
73
-
74
- `string`
75
-
76
- #### Defined in
77
-
78
- [src/IQueryable.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/IQueryable.ts#L21)
79
-
80
- ___
81
-
82
- ### onPostProcess
83
-
84
- ▸ **onPostProcess**(`connection`, `results`): `Promise`<`T`\>
85
-
86
- #### Parameters
87
-
88
- | Name | Type |
89
- | :------ | :------ |
90
- | `connection` | [`IDatabaseConnection`](IDatabaseConnection.md) |
91
- | `results` | `any` |
92
-
93
- #### Returns
94
-
95
- `Promise`<`T`\>
96
-
97
- #### Defined in
98
-
99
- [src/IQueryable.ts:24](https://github.com/breautek/storm/blob/3dcafe4/src/IQueryable.ts#L24)
100
-
101
- ___
102
-
103
- ### onPreQuery
104
-
105
- ▸ **onPreQuery**(`connection`): `Promise`<`void`\>
106
-
107
- #### Parameters
108
-
109
- | Name | Type |
110
- | :------ | :------ |
111
- | `connection` | [`IDatabaseConnection`](IDatabaseConnection.md) |
112
-
113
- #### Returns
114
-
115
- `Promise`<`void`\>
116
-
117
- #### Defined in
118
-
119
- [src/IQueryable.ts:20](https://github.com/breautek/storm/blob/3dcafe4/src/IQueryable.ts#L20)
@@ -1,37 +0,0 @@
1
- [@breautek/storm](../README.md) / IRequestResponse
2
-
3
- # Interface: IRequestResponse<TRequest, TResponse\>
4
-
5
- ## Type parameters
6
-
7
- | Name | Type |
8
- | :------ | :------ |
9
- | `TRequest` | `any` |
10
- | `TResponse` | `any` |
11
-
12
- ## Table of contents
13
-
14
- ### Properties
15
-
16
- - [request](IRequestResponse.md#request)
17
- - [response](IRequestResponse.md#response)
18
-
19
- ## Properties
20
-
21
- ### request
22
-
23
- • **request**: [`Request`](../classes/Request.md)<`TRequest`, [`IAuthTokenData`](IAuthTokenData.md)\>
24
-
25
- #### Defined in
26
-
27
- [src/IRequestResponse.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/IRequestResponse.ts#L21)
28
-
29
- ___
30
-
31
- ### response
32
-
33
- • **response**: [`Response`](../classes/Response.md)<`TResponse`, `string` \| `Error` \| [`IErrorResponse`](IErrorResponse.md)\>
34
-
35
- #### Defined in
36
-
37
- [src/IRequestResponse.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/IRequestResponse.ts#L22)
@@ -1,7 +0,0 @@
1
- [@breautek/storm](../README.md) / IServiceHeaders
2
-
3
- # Interface: IServiceHeaders
4
-
5
- ## Indexable
6
-
7
- ▪ [key: `string`]: `string`
@@ -1,30 +0,0 @@
1
- [@breautek/storm](../README.md) / ISetSessionVariableQueryInput
2
-
3
- # Interface: ISetSessionVariableQueryInput
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [name](ISetSessionVariableQueryInput.md#name)
10
- - [value](ISetSessionVariableQueryInput.md#value)
11
-
12
- ## Properties
13
-
14
- ### name
15
-
16
- • **name**: `string`
17
-
18
- #### Defined in
19
-
20
- [src/SetSessionVariableQuery.ts:7](https://github.com/breautek/storm/blob/3dcafe4/src/SetSessionVariableQuery.ts#L7)
21
-
22
- ___
23
-
24
- ### value
25
-
26
- • **value**: `any`
27
-
28
- #### Defined in
29
-
30
- [src/SetSessionVariableQuery.ts:8](https://github.com/breautek/storm/blob/3dcafe4/src/SetSessionVariableQuery.ts#L8)
@@ -1,30 +0,0 @@
1
- [@breautek/storm](../README.md) / ITemporaryTableQueryInput
2
-
3
- # Interface: ITemporaryTableQueryInput
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [selectQuery](ITemporaryTableQueryInput.md#selectquery)
10
- - [tableName](ITemporaryTableQueryInput.md#tablename)
11
-
12
- ## Properties
13
-
14
- ### selectQuery
15
-
16
- • **selectQuery**: [`Query`](../classes/Query.md)<`any`, `any`, `any`\>
17
-
18
- #### Defined in
19
-
20
- [src/TemporaryTableQuery.ts:22](https://github.com/breautek/storm/blob/3dcafe4/src/TemporaryTableQuery.ts#L22)
21
-
22
- ___
23
-
24
- ### tableName
25
-
26
- • **tableName**: `string`
27
-
28
- #### Defined in
29
-
30
- [src/TemporaryTableQuery.ts:21](https://github.com/breautek/storm/blob/3dcafe4/src/TemporaryTableQuery.ts#L21)
@@ -1,30 +0,0 @@
1
- [@breautek/storm](../README.md) / IUpdateQueryResult
2
-
3
- # Interface: IUpdateQueryResult
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [affectedRows](IUpdateQueryResult.md#affectedrows)
10
- - [changedRows](IUpdateQueryResult.md#changedrows)
11
-
12
- ## Properties
13
-
14
- ### affectedRows
15
-
16
- • **affectedRows**: `number`
17
-
18
- #### Defined in
19
-
20
- [src/IUpdateQueryResult.ts:18](https://github.com/breautek/storm/blob/3dcafe4/src/IUpdateQueryResult.ts#L18)
21
-
22
- ___
23
-
24
- ### changedRows
25
-
26
- • **changedRows**: `number`
27
-
28
- #### Defined in
29
-
30
- [src/IUpdateQueryResult.ts:19](https://github.com/breautek/storm/blob/3dcafe4/src/IUpdateQueryResult.ts#L19)
@@ -1,54 +0,0 @@
1
- [@breautek/storm](../README.md) / [formidable](../modules/formidable.md) / EmitData
2
-
3
- # Interface: EmitData
4
-
5
- [formidable](../modules/formidable.md).EmitData
6
-
7
- ## Table of contents
8
-
9
- ### Properties
10
-
11
- - [formname](formidable.EmitData.md#formname)
12
- - [key](formidable.EmitData.md#key)
13
- - [name](formidable.EmitData.md#name)
14
- - [value](formidable.EmitData.md#value)
15
-
16
- ## Properties
17
-
18
- ### formname
19
-
20
- • **formname**: `any`
21
-
22
- #### Defined in
23
-
24
- node_modules/@types/formidable/index.d.ts:246
25
-
26
- ___
27
-
28
- ### key
29
-
30
- • `Optional` **key**: `string` \| `number`
31
-
32
- #### Defined in
33
-
34
- node_modules/@types/formidable/index.d.ts:247
35
-
36
- ___
37
-
38
- ### name
39
-
40
- • **name**: ``"file"`` \| ``"fileBegin"``
41
-
42
- #### Defined in
43
-
44
- node_modules/@types/formidable/index.d.ts:248
45
-
46
- ___
47
-
48
- ### value
49
-
50
- • **value**: `string` \| [`File`](formidable.File.md)
51
-
52
- #### Defined in
53
-
54
- node_modules/@types/formidable/index.d.ts:249
@@ -1,87 +0,0 @@
1
- [@breautek/storm](../README.md) / [formidable](../modules/formidable.md) / EventData
2
-
3
- # Interface: EventData
4
-
5
- [formidable](../modules/formidable.md).EventData
6
-
7
- ## Table of contents
8
-
9
- ### Properties
10
-
11
- - [buffer](formidable.EventData.md#buffer)
12
- - [end](formidable.EventData.md#end)
13
- - [formname](formidable.EventData.md#formname)
14
- - [key](formidable.EventData.md#key)
15
- - [name](formidable.EventData.md#name)
16
- - [start](formidable.EventData.md#start)
17
- - [value](formidable.EventData.md#value)
18
-
19
- ## Properties
20
-
21
- ### buffer
22
-
23
- • **buffer**: `string`
24
-
25
- #### Defined in
26
-
27
- node_modules/@types/formidable/index.d.ts:254
28
-
29
- ___
30
-
31
- ### end
32
-
33
- • **end**: `string`
34
-
35
- #### Defined in
36
-
37
- node_modules/@types/formidable/index.d.ts:255
38
-
39
- ___
40
-
41
- ### formname
42
-
43
- • **formname**: `string`
44
-
45
- #### Defined in
46
-
47
- node_modules/@types/formidable/index.d.ts:256
48
-
49
- ___
50
-
51
- ### key
52
-
53
- • **key**: `string`
54
-
55
- #### Defined in
56
-
57
- node_modules/@types/formidable/index.d.ts:257
58
-
59
- ___
60
-
61
- ### name
62
-
63
- • **name**: [`EventNames`](../modules/formidable.md#eventnames)
64
-
65
- #### Defined in
66
-
67
- node_modules/@types/formidable/index.d.ts:253
68
-
69
- ___
70
-
71
- ### start
72
-
73
- • **start**: `string`
74
-
75
- #### Defined in
76
-
77
- node_modules/@types/formidable/index.d.ts:258
78
-
79
- ___
80
-
81
- ### value
82
-
83
- • **value**: `string`
84
-
85
- #### Defined in
86
-
87
- node_modules/@types/formidable/index.d.ts:259
@@ -1,9 +0,0 @@
1
- [@breautek/storm](../README.md) / [formidable](../modules/formidable.md) / Fields
2
-
3
- # Interface: Fields
4
-
5
- [formidable](../modules/formidable.md).Fields
6
-
7
- ## Indexable
8
-
9
- ▪ [field: `string`]: `string` \| `string`[]
@@ -1,131 +0,0 @@
1
- [@breautek/storm](../README.md) / [formidable](../modules/formidable.md) / File
2
-
3
- # Interface: File
4
-
5
- [formidable](../modules/formidable.md).File
6
-
7
- ## Table of contents
8
-
9
- ### Properties
10
-
11
- - [hash](formidable.File.md#hash)
12
- - [lastModifiedDate](formidable.File.md#lastmodifieddate)
13
- - [name](formidable.File.md#name)
14
- - [path](formidable.File.md#path)
15
- - [size](formidable.File.md#size)
16
- - [type](formidable.File.md#type)
17
-
18
- ### Methods
19
-
20
- - [toJSON](formidable.File.md#tojson)
21
- - [toString](formidable.File.md#tostring)
22
-
23
- ## Properties
24
-
25
- ### hash
26
-
27
- • `Optional` **hash**: `string`
28
-
29
- If `options.hash` calculation was set, you can read the hex digest out of this var.
30
-
31
- #### Defined in
32
-
33
- node_modules/@types/formidable/index.d.ts:232
34
-
35
- ___
36
-
37
- ### lastModifiedDate
38
-
39
- • `Optional` **lastModifiedDate**: `Date`
40
-
41
- A Date object (or `null`) containing the time this file was last written to. Mostly here for
42
- compatibility with the [W3C File API Draft](http://dev.w3.org/2006/webapi/FileAPI/).
43
-
44
- #### Defined in
45
-
46
- node_modules/@types/formidable/index.d.ts:227
47
-
48
- ___
49
-
50
- ### name
51
-
52
- • **name**: `string`
53
-
54
- The name this file had according to the uploading client.
55
-
56
- #### Defined in
57
-
58
- node_modules/@types/formidable/index.d.ts:216
59
-
60
- ___
61
-
62
- ### path
63
-
64
- • **path**: `string`
65
-
66
- The path this file is being written to. You can modify this in the `'fileBegin'` event in case
67
- you are unhappy with the way formidable generates a temporary path for your files.
68
-
69
- #### Defined in
70
-
71
- node_modules/@types/formidable/index.d.ts:211
72
-
73
- ___
74
-
75
- ### size
76
-
77
- • **size**: `number`
78
-
79
- The size of the uploaded file in bytes. If the file is still being uploaded (see `'fileBegin'`
80
- event), this property says how many bytes of the file have been written to disk yet.
81
-
82
- #### Defined in
83
-
84
- node_modules/@types/formidable/index.d.ts:205
85
-
86
- ___
87
-
88
- ### type
89
-
90
- • **type**: `string`
91
-
92
- The mime type of this file, according to the uploading client.
93
-
94
- #### Defined in
95
-
96
- node_modules/@types/formidable/index.d.ts:221
97
-
98
- ## Methods
99
-
100
- ### toJSON
101
-
102
- ▸ **toJSON**(): [`FileJSON`](formidable.FileJSON.md)
103
-
104
- This method returns a JSON-representation of the file, allowing you to JSON.stringify() the
105
- file which is useful for logging and responding to requests.
106
-
107
- **`Link`**
108
-
109
- https://github.com/node-formidable/formidable#filetojson
110
-
111
- #### Returns
112
-
113
- [`FileJSON`](formidable.FileJSON.md)
114
-
115
- #### Defined in
116
-
117
- node_modules/@types/formidable/index.d.ts:240
118
-
119
- ___
120
-
121
- ### toString
122
-
123
- ▸ **toString**(): `string`
124
-
125
- #### Returns
126
-
127
- `string`
128
-
129
- #### Defined in
130
-
131
- node_modules/@types/formidable/index.d.ts:242
@@ -1,151 +0,0 @@
1
- [@breautek/storm](../README.md) / [formidable](../modules/formidable.md) / FileJSON
2
-
3
- # Interface: FileJSON
4
-
5
- [formidable](../modules/formidable.md).FileJSON
6
-
7
- **`Link`**
8
-
9
- https://github.com/node-formidable/formidable#file
10
-
11
- ## Hierarchy
12
-
13
- - `Pick`<[`File`](formidable.File.md), ``"size"`` \| ``"path"`` \| ``"name"`` \| ``"type"`` \| ``"hash"``\>
14
-
15
- ↳ **`FileJSON`**
16
-
17
- ## Table of contents
18
-
19
- ### Properties
20
-
21
- - [filename](formidable.FileJSON.md#filename)
22
- - [hash](formidable.FileJSON.md#hash)
23
- - [length](formidable.FileJSON.md#length)
24
- - [mime](formidable.FileJSON.md#mime)
25
- - [mtime](formidable.FileJSON.md#mtime)
26
- - [name](formidable.FileJSON.md#name)
27
- - [path](formidable.FileJSON.md#path)
28
- - [size](formidable.FileJSON.md#size)
29
- - [type](formidable.FileJSON.md#type)
30
-
31
- ## Properties
32
-
33
- ### filename
34
-
35
- • **filename**: `string`
36
-
37
- #### Defined in
38
-
39
- node_modules/@types/formidable/index.d.ts:194
40
-
41
- ___
42
-
43
- ### hash
44
-
45
- • `Optional` **hash**: `string`
46
-
47
- If `options.hash` calculation was set, you can read the hex digest out of this var.
48
-
49
- #### Inherited from
50
-
51
- Pick.hash
52
-
53
- #### Defined in
54
-
55
- node_modules/@types/formidable/index.d.ts:232
56
-
57
- ___
58
-
59
- ### length
60
-
61
- • **length**: `number`
62
-
63
- #### Defined in
64
-
65
- node_modules/@types/formidable/index.d.ts:195
66
-
67
- ___
68
-
69
- ### mime
70
-
71
- • **mime**: `string`
72
-
73
- #### Defined in
74
-
75
- node_modules/@types/formidable/index.d.ts:196
76
-
77
- ___
78
-
79
- ### mtime
80
-
81
- • **mtime**: `Date`
82
-
83
- #### Defined in
84
-
85
- node_modules/@types/formidable/index.d.ts:197
86
-
87
- ___
88
-
89
- ### name
90
-
91
- • **name**: `string`
92
-
93
- The name this file had according to the uploading client.
94
-
95
- #### Inherited from
96
-
97
- Pick.name
98
-
99
- #### Defined in
100
-
101
- node_modules/@types/formidable/index.d.ts:216
102
-
103
- ___
104
-
105
- ### path
106
-
107
- • **path**: `string`
108
-
109
- The path this file is being written to. You can modify this in the `'fileBegin'` event in case
110
- you are unhappy with the way formidable generates a temporary path for your files.
111
-
112
- #### Inherited from
113
-
114
- Pick.path
115
-
116
- #### Defined in
117
-
118
- node_modules/@types/formidable/index.d.ts:211
119
-
120
- ___
121
-
122
- ### size
123
-
124
- • **size**: `number`
125
-
126
- The size of the uploaded file in bytes. If the file is still being uploaded (see `'fileBegin'`
127
- event), this property says how many bytes of the file have been written to disk yet.
128
-
129
- #### Inherited from
130
-
131
- Pick.size
132
-
133
- #### Defined in
134
-
135
- node_modules/@types/formidable/index.d.ts:205
136
-
137
- ___
138
-
139
- ### type
140
-
141
- • **type**: `string`
142
-
143
- The mime type of this file, according to the uploading client.
144
-
145
- #### Inherited from
146
-
147
- Pick.type
148
-
149
- #### Defined in
150
-
151
- node_modules/@types/formidable/index.d.ts:221
@@ -1,9 +0,0 @@
1
- [@breautek/storm](../README.md) / [formidable](../modules/formidable.md) / Files
2
-
3
- # Interface: Files
4
-
5
- [formidable](../modules/formidable.md).Files
6
-
7
- ## Indexable
8
-
9
- ▪ [file: `string`]: [`File`](formidable.File.md) \| [`File`](formidable.File.md)[]