@breautek/storm 3.4.0 → 4.0.0

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 (298) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/docs/README.md +153 -63
  3. package/docs/classes/{Application.Application-1.md → Application.md} +110 -112
  4. package/docs/classes/{BackendAuthenticationMiddleware.BackendAuthenticationMiddleware-1.md → BackendAuthenticationMiddleware.md} +6 -8
  5. package/docs/classes/CORSMiddleware.md +143 -0
  6. package/docs/classes/{ConfigLoader.ConfigLoader-1.md → ConfigLoader.md} +5 -7
  7. package/docs/classes/{Database.Database-1.md → Database.md} +30 -32
  8. package/docs/classes/{DatabaseConnection.DatabaseConnection-1.md → DatabaseConnection.md} +57 -59
  9. package/docs/classes/DatabaseQueryError.md +307 -0
  10. package/docs/classes/DiskSpaceError.md +301 -0
  11. package/docs/classes/DropTemporaryTableQuery.md +201 -0
  12. package/docs/classes/DumpStream.md +23 -0
  13. package/docs/classes/DuplicateEntryError.md +303 -0
  14. package/docs/classes/EntityNotFoundError.md +301 -0
  15. package/docs/classes/ExpiredTokenError.md +301 -0
  16. package/docs/classes/Handler.md +323 -0
  17. package/docs/classes/InternalError.md +301 -0
  18. package/docs/classes/InvalidCredentialsError.md +301 -0
  19. package/docs/classes/InvalidValueError.md +309 -0
  20. package/docs/classes/ManagedDatabaseConnection.md +397 -0
  21. package/docs/classes/Middleware.md +72 -0
  22. package/docs/classes/MissingConfigError.md +301 -0
  23. package/docs/classes/MissingParameterError.md +301 -0
  24. package/docs/classes/{MySQLConnection.MySQLConnection-1.md → MySQLConnection.md} +63 -65
  25. package/docs/classes/MySQLDatabase.md +314 -0
  26. package/docs/classes/{Query.Query-1.md → Query.md} +38 -34
  27. package/docs/classes/{RawQuery.RawQuery-1.md → RawQuery.md} +36 -32
  28. package/docs/classes/Request.md +321 -0
  29. package/docs/classes/Response.md +242 -0
  30. package/docs/classes/{ResponseData.ResponseData-1.md → ResponseData.md} +18 -20
  31. package/docs/classes/{ServiceProvider.ServiceProvider-1.md → ServiceProvider.md} +52 -54
  32. package/docs/classes/{ServiceResponse.ServiceResponse-1.md → ServiceResponse.md} +9 -11
  33. package/docs/classes/SetSessionVariableQuery.md +201 -0
  34. package/docs/classes/StormError.md +307 -0
  35. package/docs/classes/TemporaryTableQuery.md +207 -0
  36. package/docs/classes/{Token.Token-1.md → Token.md} +5 -7
  37. package/docs/classes/{TokenManager.TokenManager-1.md → TokenManager.md} +16 -18
  38. package/docs/classes/UnauthorizedAccessError.md +301 -0
  39. package/docs/enums/ErrorCode.md +107 -0
  40. package/docs/enums/ExitCode.md +30 -0
  41. package/docs/enums/HTTPMethod.md +52 -0
  42. package/docs/enums/JWTError.md +30 -0
  43. package/docs/enums/StatusCode.md +536 -0
  44. package/docs/interfaces/IAdditionalErrorDetails.md +7 -0
  45. package/docs/interfaces/{IAuthTokenData.IAuthTokenData-1.md → IAuthTokenData.md} +4 -6
  46. package/docs/interfaces/IConfig.md +112 -0
  47. package/docs/interfaces/{IDatabaseConfig.IDatabaseConfig-1.md → IDatabaseConfig.md} +13 -15
  48. package/docs/interfaces/{IDatabaseConnection.IDatabaseConnection-1.md → IDatabaseConnection.md} +33 -35
  49. package/docs/interfaces/IErrorResponse.md +52 -0
  50. package/docs/interfaces/IFormData.md +30 -0
  51. package/docs/interfaces/{IHandler.IHandler-1.md → IHandler.md} +4 -6
  52. package/docs/interfaces/IInsertQueryResult.md +41 -0
  53. package/docs/interfaces/IJWTVerifyOptions.md +19 -0
  54. package/docs/interfaces/IParameterMap.md +7 -0
  55. package/docs/interfaces/IRequestResponse.md +37 -0
  56. package/docs/interfaces/IServiceHeaders.md +7 -0
  57. package/docs/interfaces/ISetSessionVariableQueryInput.md +30 -0
  58. package/docs/interfaces/ITemporaryTableQueryInput.md +30 -0
  59. package/docs/interfaces/IUpdateQueryResult.md +30 -0
  60. package/docs/interfaces/{api.formidable.EmitData.md → formidable.EmitData.md} +7 -7
  61. package/docs/interfaces/{api.formidable.EventData.md → formidable.EventData.md} +10 -10
  62. package/docs/interfaces/formidable.Fields.md +9 -0
  63. package/docs/interfaces/{api.formidable.File.md → formidable.File.md} +12 -12
  64. package/docs/interfaces/{api.formidable.FileJSON.md → formidable.FileJSON.md} +12 -12
  65. package/docs/interfaces/formidable.Files.md +9 -0
  66. package/docs/interfaces/{api.formidable.Options.md → formidable.Options.md} +17 -15
  67. package/docs/interfaces/{api.formidable.Part.md → formidable.Part.md} +41 -41
  68. package/docs/modules/{api.formidable.md → formidable.md} +23 -25
  69. package/lib/Application.js +1 -1
  70. package/lib/Application.js.map +1 -1
  71. package/lib/BackendAuthenticationMiddleware.js +2 -2
  72. package/lib/BackendAuthenticationMiddleware.js.map +1 -1
  73. package/lib/CORSMiddleware.js +1 -1
  74. package/lib/CORSMiddleware.js.map +1 -1
  75. package/lib/ConfigLoader.js +1 -1
  76. package/lib/ConfigLoader.js.map +1 -1
  77. package/lib/Database.js +1 -1
  78. package/lib/Database.js.map +1 -1
  79. package/lib/DatabaseConnection.js +4 -4
  80. package/lib/DatabaseConnection.js.map +1 -1
  81. package/lib/Handler.js +2 -2
  82. package/lib/Handler.js.map +1 -1
  83. package/lib/ManagedDatabaseConnection.js +4 -4
  84. package/lib/ManagedDatabaseConnection.js.map +1 -1
  85. package/lib/MySQLConnection.js +7 -7
  86. package/lib/MySQLConnection.js.map +1 -1
  87. package/lib/MySQLDatabase.js +4 -4
  88. package/lib/MySQLDatabase.js.map +1 -1
  89. package/lib/Query.d.ts +2 -2
  90. package/lib/Query.js +2 -2
  91. package/lib/Query.js.map +1 -1
  92. package/lib/Request.js +2 -2
  93. package/lib/Request.js.map +1 -1
  94. package/lib/Response.js +1 -1
  95. package/lib/Response.js.map +1 -1
  96. package/lib/StormError.js +1 -1
  97. package/lib/StormError.js.map +1 -1
  98. package/lib/TemporaryTableQuery.d.ts +2 -1
  99. package/lib/TemporaryTableQuery.js +2 -2
  100. package/lib/TemporaryTableQuery.js.map +1 -1
  101. package/lib/TokenManager.js +1 -1
  102. package/lib/TokenManager.js.map +1 -1
  103. package/package.json +19 -19
  104. package/src/DatabaseConnection.ts +2 -2
  105. package/src/Query.ts +3 -3
  106. package/src/TemporaryTableQuery.ts +3 -2
  107. package/.nyc_output/01d7f3ed-ada5-4fbf-bf72-17458de5eda1.json +0 -1
  108. package/.nyc_output/07a372ea-5f20-411a-8f9b-5cfd38c9f7cf.json +0 -1
  109. package/.nyc_output/1a03fe29-15f4-4d36-a6f1-061f95c919d2.json +0 -1
  110. package/.nyc_output/1be973a3-2986-4e51-9bef-ffa834a81029.json +0 -1
  111. package/.nyc_output/1fa3f196-6284-4422-b186-8fb97ac299b1.json +0 -1
  112. package/.nyc_output/21b4136c-a3f4-465a-ab85-cdfa70dda252.json +0 -1
  113. package/.nyc_output/279ce3fa-118b-4b21-bbd4-a0dbabb3cf28.json +0 -1
  114. package/.nyc_output/370daf16-8792-4296-a491-4b0ff8c5c03d.json +0 -1
  115. package/.nyc_output/44cabfc1-f759-4ff5-9502-0967bba28c3b.json +0 -1
  116. package/.nyc_output/52cc8740-cb58-4b4e-b952-bedee8b2a4b9.json +0 -1
  117. package/.nyc_output/5359ad53-153e-4a68-9158-095880ce3682.json +0 -1
  118. package/.nyc_output/54476a59-73ed-43c2-b90f-46bad1fd2b24.json +0 -1
  119. package/.nyc_output/5e815b47-2082-47aa-8d02-548d8f0175a6.json +0 -1
  120. package/.nyc_output/6300a22c-16ee-4f46-a5bc-ac392153ef39.json +0 -1
  121. package/.nyc_output/6331ec83-1ccd-4980-8cdb-55f87f01b6a0.json +0 -1
  122. package/.nyc_output/6a819ad4-b691-45b3-b693-98f812bd3249.json +0 -1
  123. package/.nyc_output/77e0e45c-5d9f-4848-96a1-cc36e5373078.json +0 -1
  124. package/.nyc_output/790a50c9-e677-48ed-9d87-3ca0d173f7b0.json +0 -1
  125. package/.nyc_output/7dad65fb-92f5-4d0a-a576-e071c1ab73e5.json +0 -1
  126. package/.nyc_output/7ee3638f-2a2d-4d5a-9970-254a86884c40.json +0 -1
  127. package/.nyc_output/883b8a83-3a1e-4153-a987-3a2f5455a627.json +0 -1
  128. package/.nyc_output/8dc3a0b6-b04e-45f5-85ec-99efabb63499.json +0 -1
  129. package/.nyc_output/8e03b522-9fef-4fae-82c0-f51611fab55a.json +0 -1
  130. package/.nyc_output/946bad92-6c4b-4ac1-b508-83983322629c.json +0 -1
  131. package/.nyc_output/95d30443-c776-4f68-ab14-34ecdccdaee4.json +0 -1
  132. package/.nyc_output/abc21188-b3dc-4cce-bc20-f0680a4dde62.json +0 -1
  133. package/.nyc_output/ac7ebac2-d226-41f9-b271-25b0ad449de0.json +0 -1
  134. package/.nyc_output/ae1048af-74db-41a3-b4d7-e511f60259ef.json +0 -1
  135. package/.nyc_output/b121ce1e-5d6b-4b6d-93a7-21b315098afc.json +0 -1
  136. package/.nyc_output/bb6d14e4-2e75-45bd-a1f0-67c21781bcf6.json +0 -1
  137. package/.nyc_output/c5d84f76-682f-429c-9b0d-241c81a72907.json +0 -1
  138. package/.nyc_output/d14c616f-ca9b-402d-879d-c7e91ecc6b89.json +0 -1
  139. package/.nyc_output/d3096a06-29ef-4de7-b565-b7b1ca58471a.json +0 -1
  140. package/.nyc_output/d6313ced-0715-41aa-a0bb-22eeae3cccc1.json +0 -1
  141. package/.nyc_output/e7143b16-9cb3-4900-9498-05c40f90af46.json +0 -1
  142. package/.nyc_output/eb21b824-fc88-4f0c-9e72-bd691a141b75.json +0 -1
  143. package/.nyc_output/ee09e08d-c0f5-4fba-9fa1-849b0f32f347.json +0 -1
  144. package/.nyc_output/ee8b9792-e4fc-4950-8532-733858a2a7f2.json +0 -1
  145. package/.nyc_output/f4344c1d-e947-4c51-abe0-e3600b4e721d.json +0 -1
  146. package/.nyc_output/f7d0a4d2-62db-494d-bb67-78e3f93ae05b.json +0 -1
  147. package/.nyc_output/processinfo/01d7f3ed-ada5-4fbf-bf72-17458de5eda1.json +0 -1
  148. package/.nyc_output/processinfo/07a372ea-5f20-411a-8f9b-5cfd38c9f7cf.json +0 -1
  149. package/.nyc_output/processinfo/1a03fe29-15f4-4d36-a6f1-061f95c919d2.json +0 -1
  150. package/.nyc_output/processinfo/1be973a3-2986-4e51-9bef-ffa834a81029.json +0 -1
  151. package/.nyc_output/processinfo/1fa3f196-6284-4422-b186-8fb97ac299b1.json +0 -1
  152. package/.nyc_output/processinfo/21b4136c-a3f4-465a-ab85-cdfa70dda252.json +0 -1
  153. package/.nyc_output/processinfo/279ce3fa-118b-4b21-bbd4-a0dbabb3cf28.json +0 -1
  154. package/.nyc_output/processinfo/370daf16-8792-4296-a491-4b0ff8c5c03d.json +0 -1
  155. package/.nyc_output/processinfo/44cabfc1-f759-4ff5-9502-0967bba28c3b.json +0 -1
  156. package/.nyc_output/processinfo/52cc8740-cb58-4b4e-b952-bedee8b2a4b9.json +0 -1
  157. package/.nyc_output/processinfo/5359ad53-153e-4a68-9158-095880ce3682.json +0 -1
  158. package/.nyc_output/processinfo/54476a59-73ed-43c2-b90f-46bad1fd2b24.json +0 -1
  159. package/.nyc_output/processinfo/5e815b47-2082-47aa-8d02-548d8f0175a6.json +0 -1
  160. package/.nyc_output/processinfo/6300a22c-16ee-4f46-a5bc-ac392153ef39.json +0 -1
  161. package/.nyc_output/processinfo/6331ec83-1ccd-4980-8cdb-55f87f01b6a0.json +0 -1
  162. package/.nyc_output/processinfo/6a819ad4-b691-45b3-b693-98f812bd3249.json +0 -1
  163. package/.nyc_output/processinfo/77e0e45c-5d9f-4848-96a1-cc36e5373078.json +0 -1
  164. package/.nyc_output/processinfo/790a50c9-e677-48ed-9d87-3ca0d173f7b0.json +0 -1
  165. package/.nyc_output/processinfo/7dad65fb-92f5-4d0a-a576-e071c1ab73e5.json +0 -1
  166. package/.nyc_output/processinfo/7ee3638f-2a2d-4d5a-9970-254a86884c40.json +0 -1
  167. package/.nyc_output/processinfo/883b8a83-3a1e-4153-a987-3a2f5455a627.json +0 -1
  168. package/.nyc_output/processinfo/8dc3a0b6-b04e-45f5-85ec-99efabb63499.json +0 -1
  169. package/.nyc_output/processinfo/8e03b522-9fef-4fae-82c0-f51611fab55a.json +0 -1
  170. package/.nyc_output/processinfo/946bad92-6c4b-4ac1-b508-83983322629c.json +0 -1
  171. package/.nyc_output/processinfo/95d30443-c776-4f68-ab14-34ecdccdaee4.json +0 -1
  172. package/.nyc_output/processinfo/abc21188-b3dc-4cce-bc20-f0680a4dde62.json +0 -1
  173. package/.nyc_output/processinfo/ac7ebac2-d226-41f9-b271-25b0ad449de0.json +0 -1
  174. package/.nyc_output/processinfo/ae1048af-74db-41a3-b4d7-e511f60259ef.json +0 -1
  175. package/.nyc_output/processinfo/b121ce1e-5d6b-4b6d-93a7-21b315098afc.json +0 -1
  176. package/.nyc_output/processinfo/bb6d14e4-2e75-45bd-a1f0-67c21781bcf6.json +0 -1
  177. package/.nyc_output/processinfo/c5d84f76-682f-429c-9b0d-241c81a72907.json +0 -1
  178. package/.nyc_output/processinfo/d14c616f-ca9b-402d-879d-c7e91ecc6b89.json +0 -1
  179. package/.nyc_output/processinfo/d3096a06-29ef-4de7-b565-b7b1ca58471a.json +0 -1
  180. package/.nyc_output/processinfo/d6313ced-0715-41aa-a0bb-22eeae3cccc1.json +0 -1
  181. package/.nyc_output/processinfo/e7143b16-9cb3-4900-9498-05c40f90af46.json +0 -1
  182. package/.nyc_output/processinfo/eb21b824-fc88-4f0c-9e72-bd691a141b75.json +0 -1
  183. package/.nyc_output/processinfo/ee09e08d-c0f5-4fba-9fa1-849b0f32f347.json +0 -1
  184. package/.nyc_output/processinfo/ee8b9792-e4fc-4950-8532-733858a2a7f2.json +0 -1
  185. package/.nyc_output/processinfo/f4344c1d-e947-4c51-abe0-e3600b4e721d.json +0 -1
  186. package/.nyc_output/processinfo/f7d0a4d2-62db-494d-bb67-78e3f93ae05b.json +0 -1
  187. package/.nyc_output/processinfo/index.json +0 -1
  188. package/docs/classes/CORSMiddleware.CORSMiddleware-1.md +0 -145
  189. package/docs/classes/DatabaseQueryError.DatabaseQueryError-1.md +0 -309
  190. package/docs/classes/DiskSpaceError.DiskSpaceError-1.md +0 -303
  191. package/docs/classes/DropTemporaryTableQuery.DropTemporaryTableQuery-1.md +0 -197
  192. package/docs/classes/DumpStream.DumpStream-1.md +0 -25
  193. package/docs/classes/DuplicateEntryError.DuplicateEntryError-1.md +0 -305
  194. package/docs/classes/EntityNotFoundError.EntityNotFoundError-1.md +0 -303
  195. package/docs/classes/ExpiredTokenError.ExpiredTokenError-1.md +0 -303
  196. package/docs/classes/Handler.Handler-1.md +0 -325
  197. package/docs/classes/InternalError.InternalError-1.md +0 -303
  198. package/docs/classes/InvalidConfigError.InvalidConfigError-1.md +0 -316
  199. package/docs/classes/InvalidCredentialsError.InvalidCredentialsError-1.md +0 -303
  200. package/docs/classes/InvalidValueError.InvalidValueError-1.md +0 -311
  201. package/docs/classes/JWTVerifyOptionsParser.JWTVerifyOptionsParser-1.md +0 -45
  202. package/docs/classes/ManagedDatabaseConnection.ManagedDatabaseConnection-1.md +0 -399
  203. package/docs/classes/Middleware.Middleware-1.md +0 -74
  204. package/docs/classes/MissingConfigError.MissingConfigError-1.md +0 -303
  205. package/docs/classes/MissingParameterError.MissingParameterError-1.md +0 -303
  206. package/docs/classes/MySQLDatabase.MySQLDatabase-1.md +0 -316
  207. package/docs/classes/Request.Request-1.md +0 -323
  208. package/docs/classes/Response.Response-1.md +0 -244
  209. package/docs/classes/SetSessionVariableQuery.SetSessionVariableQuery-1.md +0 -197
  210. package/docs/classes/StormError.StormError-1.md +0 -309
  211. package/docs/classes/TemporaryTableQuery.TemporaryTableQuery-1.md +0 -197
  212. package/docs/classes/UnauthorizedAccessError.UnauthorizedAccessError-1.md +0 -301
  213. package/docs/classes/private_CommitQuery.CommitQuery.md +0 -197
  214. package/docs/classes/private_RollbackQuery.RollbackQuery.md +0 -197
  215. package/docs/classes/private_StartTransactionQuery.StartTransactionQuery.md +0 -197
  216. package/docs/enums/ApplicationEvent.ApplicationEvent-1.md +0 -21
  217. package/docs/enums/ErrorCode.ErrorCode-1.md +0 -109
  218. package/docs/enums/ExitCode.ExitCode-1.md +0 -32
  219. package/docs/enums/HTTPMethod.HTTPMethod-1.md +0 -54
  220. package/docs/enums/JWTError.JWTError-1.md +0 -32
  221. package/docs/enums/StatusCode.StatusCode-1.md +0 -538
  222. package/docs/interfaces/DropTemporaryTableQuery.IDropTemporaryTableQueryInput.md +0 -21
  223. package/docs/interfaces/IConfig.IConfig-1.md +0 -114
  224. package/docs/interfaces/IFormData.IFormData-1.md +0 -32
  225. package/docs/interfaces/IInsertQueryResult.IInsertQueryResult-1.md +0 -43
  226. package/docs/interfaces/IJWTVerifyOptions.IJWTVerifyOptions-1.md +0 -21
  227. package/docs/interfaces/IRequestResponse.IRequestResponse-1.md +0 -39
  228. package/docs/interfaces/IServiceHeaders.IServiceHeaders-1.md +0 -9
  229. package/docs/interfaces/IUpdateQueryResult.IUpdateQueryResult-1.md +0 -32
  230. package/docs/interfaces/Request.IParameterMap.md +0 -9
  231. package/docs/interfaces/Response.IHeaderKeyValuePair.md +0 -9
  232. package/docs/interfaces/SetSessionVariableQuery.ISetSessionVariableQueryInput.md +0 -32
  233. package/docs/interfaces/StormError.IAdditionalErrorDetails.md +0 -9
  234. package/docs/interfaces/StormError.IErrorResponse.md +0 -54
  235. package/docs/interfaces/TemporaryTableQuery.ITemporaryTableQueryInput.md +0 -32
  236. package/docs/interfaces/api.formidable.Fields.md +0 -9
  237. package/docs/interfaces/api.formidable.Files.md +0 -9
  238. package/docs/modules/Application.md +0 -9
  239. package/docs/modules/ApplicationEvent.md +0 -9
  240. package/docs/modules/BackendAuthenticationMiddleware.md +0 -9
  241. package/docs/modules/CORSMiddleware.md +0 -9
  242. package/docs/modules/ConfigLoader.md +0 -9
  243. package/docs/modules/Database.md +0 -9
  244. package/docs/modules/DatabaseConnection.md +0 -34
  245. package/docs/modules/DatabaseQueryError.md +0 -9
  246. package/docs/modules/DiskSpaceError.md +0 -9
  247. package/docs/modules/DropTemporaryTableQuery.md +0 -13
  248. package/docs/modules/DumpStream.md +0 -9
  249. package/docs/modules/DuplicateEntryError.md +0 -9
  250. package/docs/modules/EntityNotFoundError.md +0 -9
  251. package/docs/modules/ErrorCode.md +0 -9
  252. package/docs/modules/ExitCode.md +0 -9
  253. package/docs/modules/ExpiredTokenError.md +0 -9
  254. package/docs/modules/HTTPMethod.md +0 -9
  255. package/docs/modules/Handler.md +0 -50
  256. package/docs/modules/IAuthTokenData.md +0 -9
  257. package/docs/modules/IConfig.md +0 -9
  258. package/docs/modules/IDatabaseConfig.md +0 -9
  259. package/docs/modules/IDatabaseConnection.md +0 -9
  260. package/docs/modules/IDeleteQueryResult.md +0 -19
  261. package/docs/modules/IFormData.md +0 -9
  262. package/docs/modules/IHandler.md +0 -9
  263. package/docs/modules/IInsertQueryResult.md +0 -9
  264. package/docs/modules/IJWTVerifyOptions.md +0 -9
  265. package/docs/modules/IRequestResponse.md +0 -9
  266. package/docs/modules/IServiceHeaders.md +0 -9
  267. package/docs/modules/IUpdateQueryResult.md +0 -9
  268. package/docs/modules/InternalError.md +0 -9
  269. package/docs/modules/InvalidConfigError.md +0 -9
  270. package/docs/modules/InvalidCredentialsError.md +0 -9
  271. package/docs/modules/InvalidValueError.md +0 -9
  272. package/docs/modules/JWTError.md +0 -9
  273. package/docs/modules/JWTVerifyOptionsParser.md +0 -9
  274. package/docs/modules/ManagedDatabaseConnection.md +0 -9
  275. package/docs/modules/Middleware.md +0 -9
  276. package/docs/modules/MissingConfigError.md +0 -9
  277. package/docs/modules/MissingParameterError.md +0 -9
  278. package/docs/modules/MySQLConnection.md +0 -9
  279. package/docs/modules/MySQLDatabase.md +0 -9
  280. package/docs/modules/Query.md +0 -9
  281. package/docs/modules/RawQuery.md +0 -9
  282. package/docs/modules/Request.md +0 -13
  283. package/docs/modules/Response.md +0 -27
  284. package/docs/modules/ResponseData.md +0 -9
  285. package/docs/modules/ServiceProvider.md +0 -9
  286. package/docs/modules/ServiceResponse.md +0 -9
  287. package/docs/modules/SetSessionVariableQuery.md +0 -13
  288. package/docs/modules/StatusCode.md +0 -9
  289. package/docs/modules/StormError.md +0 -14
  290. package/docs/modules/TemporaryTableQuery.md +0 -13
  291. package/docs/modules/Token.md +0 -9
  292. package/docs/modules/TokenManager.md +0 -9
  293. package/docs/modules/UnauthorizedAccessError.md +0 -9
  294. package/docs/modules/api.md +0 -453
  295. package/docs/modules/instance.md +0 -44
  296. package/docs/modules/private_CommitQuery.md +0 -9
  297. package/docs/modules/private_RollbackQuery.md +0 -9
  298. package/docs/modules/private_StartTransactionQuery.md +0 -9
@@ -1,17 +1,15 @@
1
- [@breautek/storm](../README.md) / [Application](../modules/Application.md) / Application
1
+ [@breautek/storm](../README.md) / Application
2
2
 
3
3
  # Class: Application<TConfig, TAuthToken, TDBConfig, TDBConnectionAPI\>
4
4
 
5
- [Application](../modules/Application.md).Application
6
-
7
5
  Main entry point for the Application. Should be extended and have the abstract methods implemented.
8
6
 
9
7
  ## Type parameters
10
8
 
11
9
  | Name | Type |
12
10
  | :------ | :------ |
13
- | `TConfig` | extends [`IConfig`](../interfaces/IConfig.IConfig-1.md)[`IConfig`](../interfaces/IConfig.IConfig-1.md) |
14
- | `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)[`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md) |
11
+ | `TConfig` | extends [`IConfig`](../interfaces/IConfig.md) = [`IConfig`](../interfaces/IConfig.md) |
12
+ | `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
15
13
  | `TDBConfig` | `any` |
16
14
  | `TDBConnectionAPI` | `any` |
17
15
 
@@ -25,61 +23,61 @@ Main entry point for the Application. Should be extended and have the abstract m
25
23
 
26
24
  ### Constructors
27
25
 
28
- - [constructor](Application.Application-1.md#constructor)
26
+ - [constructor](Application.md#constructor)
29
27
 
30
28
  ### Properties
31
29
 
32
- - [captureRejectionSymbol](Application.Application-1.md#capturerejectionsymbol)
33
- - [captureRejections](Application.Application-1.md#capturerejections)
34
- - [defaultMaxListeners](Application.Application-1.md#defaultmaxlisteners)
35
- - [errorMonitor](Application.Application-1.md#errormonitor)
30
+ - [captureRejectionSymbol](Application.md#capturerejectionsymbol)
31
+ - [captureRejections](Application.md#capturerejections)
32
+ - [defaultMaxListeners](Application.md#defaultmaxlisteners)
33
+ - [errorMonitor](Application.md#errormonitor)
36
34
 
37
35
  ### Methods
38
36
 
39
- - [\_attachHandlers](Application.Application-1.md#_attachhandlers)
40
- - [\_buildArgOptions](Application.Application-1.md#_buildargoptions)
41
- - [\_closeDatabase](Application.Application-1.md#_closedatabase)
42
- - [\_closeSocket](Application.Application-1.md#_closesocket)
43
- - [\_initDB](Application.Application-1.md#_initdb)
44
- - [\_initLogger](Application.Application-1.md#_initlogger)
45
- - [\_initialize](Application.Application-1.md#_initialize)
46
- - [\_onBeforeReadyAsync](Application.Application-1.md#_onbeforereadyasync)
47
- - [\_onConfigLoad](Application.Application-1.md#_onconfigload)
48
- - [\_onReady](Application.Application-1.md#_onready)
49
- - [addListener](Application.Application-1.md#addlistener)
50
- - [attachHandler](Application.Application-1.md#attachhandler)
51
- - [attachHandlerInstance](Application.Application-1.md#attachhandlerinstance)
52
- - [close](Application.Application-1.md#close)
53
- - [emit](Application.Application-1.md#emit)
54
- - [eventNames](Application.Application-1.md#eventnames)
55
- - [getCmdLineArgs](Application.Application-1.md#getcmdlineargs)
56
- - [getConfig](Application.Application-1.md#getconfig)
57
- - [getDB](Application.Application-1.md#getdb)
58
- - [getLogger](Application.Application-1.md#getlogger)
59
- - [getMaxListeners](Application.Application-1.md#getmaxlisteners)
60
- - [getName](Application.Application-1.md#getname)
61
- - [getPort](Application.Application-1.md#getport)
62
- - [getProgram](Application.Application-1.md#getprogram)
63
- - [getRequestSizeLimit](Application.Application-1.md#getrequestsizelimit)
64
- - [getTokenManager](Application.Application-1.md#gettokenmanager)
65
- - [listenerCount](Application.Application-1.md#listenercount)
66
- - [listeners](Application.Application-1.md#listeners)
67
- - [loadConfig](Application.Application-1.md#loadconfig)
68
- - [off](Application.Application-1.md#off)
69
- - [on](Application.Application-1.md#on)
70
- - [once](Application.Application-1.md#once)
71
- - [prependListener](Application.Application-1.md#prependlistener)
72
- - [prependOnceListener](Application.Application-1.md#prependoncelistener)
73
- - [rawListeners](Application.Application-1.md#rawlisteners)
74
- - [removeAllListeners](Application.Application-1.md#removealllisteners)
75
- - [removeListener](Application.Application-1.md#removelistener)
76
- - [setMaxListeners](Application.Application-1.md#setmaxlisteners)
77
- - [setTokenManager](Application.Application-1.md#settokenmanager)
78
- - [shouldListen](Application.Application-1.md#shouldlisten)
79
- - [getEventListeners](Application.Application-1.md#geteventlisteners)
80
- - [listenerCount](Application.Application-1.md#listenercount)
81
- - [on](Application.Application-1.md#on)
82
- - [once](Application.Application-1.md#once)
37
+ - [\_attachHandlers](Application.md#_attachhandlers)
38
+ - [\_buildArgOptions](Application.md#_buildargoptions)
39
+ - [\_closeDatabase](Application.md#_closedatabase)
40
+ - [\_closeSocket](Application.md#_closesocket)
41
+ - [\_initDB](Application.md#_initdb)
42
+ - [\_initLogger](Application.md#_initlogger)
43
+ - [\_initialize](Application.md#_initialize)
44
+ - [\_onBeforeReadyAsync](Application.md#_onbeforereadyasync)
45
+ - [\_onConfigLoad](Application.md#_onconfigload)
46
+ - [\_onReady](Application.md#_onready)
47
+ - [addListener](Application.md#addlistener)
48
+ - [attachHandler](Application.md#attachhandler)
49
+ - [attachHandlerInstance](Application.md#attachhandlerinstance)
50
+ - [close](Application.md#close)
51
+ - [emit](Application.md#emit)
52
+ - [eventNames](Application.md#eventnames)
53
+ - [getCmdLineArgs](Application.md#getcmdlineargs)
54
+ - [getConfig](Application.md#getconfig)
55
+ - [getDB](Application.md#getdb)
56
+ - [getLogger](Application.md#getlogger)
57
+ - [getMaxListeners](Application.md#getmaxlisteners)
58
+ - [getName](Application.md#getname)
59
+ - [getPort](Application.md#getport)
60
+ - [getProgram](Application.md#getprogram)
61
+ - [getRequestSizeLimit](Application.md#getrequestsizelimit)
62
+ - [getTokenManager](Application.md#gettokenmanager)
63
+ - [listenerCount](Application.md#listenercount)
64
+ - [listeners](Application.md#listeners)
65
+ - [loadConfig](Application.md#loadconfig)
66
+ - [off](Application.md#off)
67
+ - [on](Application.md#on)
68
+ - [once](Application.md#once)
69
+ - [prependListener](Application.md#prependlistener)
70
+ - [prependOnceListener](Application.md#prependoncelistener)
71
+ - [rawListeners](Application.md#rawlisteners)
72
+ - [removeAllListeners](Application.md#removealllisteners)
73
+ - [removeListener](Application.md#removelistener)
74
+ - [setMaxListeners](Application.md#setmaxlisteners)
75
+ - [setTokenManager](Application.md#settokenmanager)
76
+ - [shouldListen](Application.md#shouldlisten)
77
+ - [getEventListeners](Application.md#geteventlisteners)
78
+ - [listenerCount](Application.md#listenercount)
79
+ - [on](Application.md#on)
80
+ - [once](Application.md#once)
83
81
 
84
82
  ## Constructors
85
83
 
@@ -91,8 +89,8 @@ Main entry point for the Application. Should be extended and have the abstract m
91
89
 
92
90
  | Name | Type |
93
91
  | :------ | :------ |
94
- | `TConfig` | extends [`IConfig`](../interfaces/IConfig.IConfig-1.md)[`IConfig`](../interfaces/IConfig.IConfig-1.md) |
95
- | `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)[`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md) |
92
+ | `TConfig` | extends [`IConfig`](../interfaces/IConfig.md) = [`IConfig`](../interfaces/IConfig.md) |
93
+ | `TAuthToken` | extends [`IAuthTokenData`](../interfaces/IAuthTokenData.md) = [`IAuthTokenData`](../interfaces/IAuthTokenData.md) |
96
94
  | `TDBConfig` | `any` |
97
95
  | `TDBConnectionAPI` | `any` |
98
96
 
@@ -109,13 +107,13 @@ EventEmitter.constructor
109
107
 
110
108
  #### Defined in
111
109
 
112
- [src/Application.ts:64](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L64)
110
+ [src/Application.ts:64](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L64)
113
111
 
114
112
  ## Properties
115
113
 
116
114
  ### captureRejectionSymbol
117
115
 
118
- ▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](Application.Application-1.md#capturerejectionsymbol)
116
+ ▪ `Static` `Readonly` **captureRejectionSymbol**: typeof [`captureRejectionSymbol`](Application.md#capturerejectionsymbol)
119
117
 
120
118
  #### Inherited from
121
119
 
@@ -159,7 +157,7 @@ ___
159
157
 
160
158
  ### errorMonitor
161
159
 
162
- ▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](Application.Application-1.md#errormonitor)
160
+ ▪ `Static` `Readonly` **errorMonitor**: typeof [`errorMonitor`](Application.md#errormonitor)
163
161
 
164
162
  This symbol shall be used to install a listener for only monitoring `'error'`
165
163
  events. Listeners installed using this symbol are called before the regular
@@ -193,7 +191,7 @@ Promise<void>
193
191
 
194
192
  #### Defined in
195
193
 
196
- [src/Application.ts:272](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L272)
194
+ [src/Application.ts:272](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L272)
197
195
 
198
196
  ___
199
197
 
@@ -213,7 +211,7 @@ ___
213
211
 
214
212
  #### Defined in
215
213
 
216
- [src/Application.ts:202](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L202)
214
+ [src/Application.ts:202](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L202)
217
215
 
218
216
  ___
219
217
 
@@ -227,7 +225,7 @@ ___
227
225
 
228
226
  #### Defined in
229
227
 
230
- [src/Application.ts:249](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L249)
228
+ [src/Application.ts:249](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L249)
231
229
 
232
230
  ___
233
231
 
@@ -241,13 +239,13 @@ ___
241
239
 
242
240
  #### Defined in
243
241
 
244
- [src/Application.ts:255](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L255)
242
+ [src/Application.ts:255](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L255)
245
243
 
246
244
  ___
247
245
 
248
246
  ### \_initDB
249
247
 
250
- ▸ `Protected` **_initDB**(`config`): `Promise`<[`Database`](Database.Database-1.md)<`TDBConfig`, `TDBConnectionAPI`\>\>
248
+ ▸ `Protected` **_initDB**(`config`): `Promise`<[`Database`](Database.md)<`TDBConfig`, `TDBConnectionAPI`\>\>
251
249
 
252
250
  Subclasses are expected to override this to configure their database setup, if the service uses a database.
253
251
 
@@ -259,11 +257,11 @@ Subclasses are expected to override this to configure their database setup, if t
259
257
 
260
258
  #### Returns
261
259
 
262
- `Promise`<[`Database`](Database.Database-1.md)<`TDBConfig`, `TDBConnectionAPI`\>\>
260
+ `Promise`<[`Database`](Database.md)<`TDBConfig`, `TDBConnectionAPI`\>\>
263
261
 
264
262
  #### Defined in
265
263
 
266
- [src/Application.ts:381](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L381)
264
+ [src/Application.ts:381](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L381)
267
265
 
268
266
  ___
269
267
 
@@ -283,7 +281,7 @@ ___
283
281
 
284
282
  #### Defined in
285
283
 
286
- [src/Application.ts:165](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L165)
284
+ [src/Application.ts:165](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L165)
287
285
 
288
286
  ___
289
287
 
@@ -303,7 +301,7 @@ ___
303
301
 
304
302
  #### Defined in
305
303
 
306
- [src/Application.ts:161](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L161)
304
+ [src/Application.ts:161](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L161)
307
305
 
308
306
  ___
309
307
 
@@ -317,7 +315,7 @@ ___
317
315
 
318
316
  #### Defined in
319
317
 
320
- [src/Application.ts:385](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L385)
318
+ [src/Application.ts:385](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L385)
321
319
 
322
320
  ___
323
321
 
@@ -339,7 +337,7 @@ Invoked once the config has been loaded and ready to be used.
339
337
 
340
338
  #### Defined in
341
339
 
342
- [src/Application.ts:325](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L325)
340
+ [src/Application.ts:325](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L325)
343
341
 
344
342
  ___
345
343
 
@@ -355,13 +353,13 @@ Invoked when the application is considered ready for operation.
355
353
 
356
354
  #### Defined in
357
355
 
358
- [src/Application.ts:390](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L390)
356
+ [src/Application.ts:390](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L390)
359
357
 
360
358
  ___
361
359
 
362
360
  ### addListener
363
361
 
364
- ▸ **addListener**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
362
+ ▸ **addListener**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
365
363
 
366
364
  Alias for `emitter.on(eventName, listener)`.
367
365
 
@@ -376,7 +374,7 @@ Alias for `emitter.on(eventName, listener)`.
376
374
 
377
375
  #### Returns
378
376
 
379
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
377
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
380
378
 
381
379
  #### Inherited from
382
380
 
@@ -397,7 +395,7 @@ ___
397
395
  | Name | Type | Description |
398
396
  | :------ | :------ | :------ |
399
397
  | `path` | `string` | The URL API path. E.g. /api/myService/myCommand/ |
400
- | `HandlerClass` | [`IHandler`](../interfaces/IHandler.IHandler-1.md)<[`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>\> | The concrete class (not the instance) of Handler to be used for this API. |
398
+ | `HandlerClass` | [`IHandler`](../interfaces/IHandler.md)<[`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>\> | The concrete class (not the instance) of Handler to be used for this API. |
401
399
 
402
400
  #### Returns
403
401
 
@@ -405,7 +403,7 @@ ___
405
403
 
406
404
  #### Defined in
407
405
 
408
- [src/Application.ts:221](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L221)
406
+ [src/Application.ts:221](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L221)
409
407
 
410
408
  ___
411
409
 
@@ -418,7 +416,7 @@ ___
418
416
  | Name | Type |
419
417
  | :------ | :------ |
420
418
  | `path` | `string` |
421
- | `handler` | [`Handler`](Handler.Handler-1.md)<[`Application`](Application.Application-1.md)<[`IConfig`](../interfaces/IConfig.IConfig-1.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md), `any`, `any`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> |
419
+ | `handler` | [`Handler`](Handler.md)<[`Application`](Application.md)<[`IConfig`](../interfaces/IConfig.md), [`IAuthTokenData`](../interfaces/IAuthTokenData.md), `any`, `any`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> |
422
420
 
423
421
  #### Returns
424
422
 
@@ -426,7 +424,7 @@ ___
426
424
 
427
425
  #### Defined in
428
426
 
429
- [src/Application.ts:226](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L226)
427
+ [src/Application.ts:226](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L226)
430
428
 
431
429
  ___
432
430
 
@@ -440,7 +438,7 @@ ___
440
438
 
441
439
  #### Defined in
442
440
 
443
- [src/Application.ts:245](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L245)
441
+ [src/Application.ts:245](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L245)
444
442
 
445
443
  ___
446
444
 
@@ -557,7 +555,7 @@ command line arguments
557
555
 
558
556
  #### Defined in
559
557
 
560
- [src/Application.ts:352](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L352)
558
+ [src/Application.ts:352](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L352)
561
559
 
562
560
  ___
563
561
 
@@ -573,23 +571,23 @@ the config object.
573
571
 
574
572
  #### Defined in
575
573
 
576
- [src/Application.ts:309](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L309)
574
+ [src/Application.ts:309](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L309)
577
575
 
578
576
  ___
579
577
 
580
578
  ### getDB
581
579
 
582
- ▸ **getDB**(): [`Database`](Database.Database-1.md)<`TDBConfig`, `TDBConnectionAPI`\>
580
+ ▸ **getDB**(): [`Database`](Database.md)<`TDBConfig`, `TDBConnectionAPI`\>
583
581
 
584
582
  #### Returns
585
583
 
586
- [`Database`](Database.Database-1.md)<`TDBConfig`, `TDBConnectionAPI`\>
584
+ [`Database`](Database.md)<`TDBConfig`, `TDBConnectionAPI`\>
587
585
 
588
586
  the database pool. This will need to be casted based on your preferred database dialect.
589
587
 
590
588
  #### Defined in
591
589
 
592
- [src/Application.ts:345](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L345)
590
+ [src/Application.ts:345](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L345)
593
591
 
594
592
  ___
595
593
 
@@ -603,7 +601,7 @@ ___
603
601
 
604
602
  #### Defined in
605
603
 
606
- [src/Application.ts:169](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L169)
604
+ [src/Application.ts:169](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L169)
607
605
 
608
606
  ___
609
607
 
@@ -612,7 +610,7 @@ ___
612
610
  ▸ **getMaxListeners**(): `number`
613
611
 
614
612
  Returns the current max listener value for the `EventEmitter` which is either
615
- set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](Application.Application-1.md#defaultmaxlisteners).
613
+ set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](Application.md#defaultmaxlisteners).
616
614
 
617
615
  **`since`** v1.0.0
618
616
 
@@ -642,7 +640,7 @@ the application name
642
640
 
643
641
  #### Defined in
644
642
 
645
- [src/Application.ts:298](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L298)
643
+ [src/Application.ts:298](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L298)
646
644
 
647
645
  ___
648
646
 
@@ -656,7 +654,7 @@ ___
656
654
 
657
655
  #### Defined in
658
656
 
659
- [src/Application.ts:173](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L173)
657
+ [src/Application.ts:173](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L173)
660
658
 
661
659
  ___
662
660
 
@@ -670,7 +668,7 @@ ___
670
668
 
671
669
  #### Defined in
672
670
 
673
- [src/Application.ts:204](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L204)
671
+ [src/Application.ts:204](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L204)
674
672
 
675
673
  ___
676
674
 
@@ -686,23 +684,23 @@ The maximum size limit for incoming requests that this service needs to handle.
686
684
 
687
685
  #### Defined in
688
686
 
689
- [src/Application.ts:211](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L211)
687
+ [src/Application.ts:211](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L211)
690
688
 
691
689
  ___
692
690
 
693
691
  ### getTokenManager
694
692
 
695
- ▸ **getTokenManager**(): [`TokenManager`](TokenManager.TokenManager-1.md)<`TAuthToken`\>
693
+ ▸ **getTokenManager**(): [`TokenManager`](TokenManager.md)<`TAuthToken`\>
696
694
 
697
695
  #### Returns
698
696
 
699
- [`TokenManager`](TokenManager.TokenManager-1.md)<`TAuthToken`\>
697
+ [`TokenManager`](TokenManager.md)<`TAuthToken`\>
700
698
 
701
699
  the token manager
702
700
 
703
701
  #### Defined in
704
702
 
705
- [src/Application.ts:338](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L338)
703
+ [src/Application.ts:338](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L338)
706
704
 
707
705
  ___
708
706
 
@@ -786,13 +784,13 @@ ___
786
784
 
787
785
  #### Defined in
788
786
 
789
- [src/Application.ts:278](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L278)
787
+ [src/Application.ts:278](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L278)
790
788
 
791
789
  ___
792
790
 
793
791
  ### off
794
792
 
795
- ▸ **off**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
793
+ ▸ **off**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
796
794
 
797
795
  Alias for `emitter.removeListener()`.
798
796
 
@@ -807,7 +805,7 @@ Alias for `emitter.removeListener()`.
807
805
 
808
806
  #### Returns
809
807
 
810
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
808
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
811
809
 
812
810
  #### Inherited from
813
811
 
@@ -821,7 +819,7 @@ ___
821
819
 
822
820
  ### on
823
821
 
824
- ▸ **on**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
822
+ ▸ **on**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
825
823
 
826
824
  Adds the `listener` function to the end of the listeners array for the
827
825
  event named `eventName`. No checks are made to see if the `listener` has
@@ -860,7 +858,7 @@ myEE.emit('foo');
860
858
 
861
859
  #### Returns
862
860
 
863
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
861
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
864
862
 
865
863
  #### Inherited from
866
864
 
@@ -874,7 +872,7 @@ ___
874
872
 
875
873
  ### once
876
874
 
877
- ▸ **once**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
875
+ ▸ **once**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
878
876
 
879
877
  Adds a **one-time**`listener` function for the event named `eventName`. The
880
878
  next time `eventName` is triggered, this listener is removed and then invoked.
@@ -911,7 +909,7 @@ myEE.emit('foo');
911
909
 
912
910
  #### Returns
913
911
 
914
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
912
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
915
913
 
916
914
  #### Inherited from
917
915
 
@@ -925,7 +923,7 @@ ___
925
923
 
926
924
  ### prependListener
927
925
 
928
- ▸ **prependListener**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
926
+ ▸ **prependListener**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
929
927
 
930
928
  Adds the `listener` function to the _beginning_ of the listeners array for the
931
929
  event named `eventName`. No checks are made to see if the `listener` has
@@ -951,7 +949,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
951
949
 
952
950
  #### Returns
953
951
 
954
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
952
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
955
953
 
956
954
  #### Inherited from
957
955
 
@@ -965,7 +963,7 @@ ___
965
963
 
966
964
  ### prependOnceListener
967
965
 
968
- ▸ **prependOnceListener**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
966
+ ▸ **prependOnceListener**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
969
967
 
970
968
  Adds a **one-time**`listener` function for the event named `eventName` to the_beginning_ of the listeners array. The next time `eventName` is triggered, this
971
969
  listener is removed, and then invoked.
@@ -989,7 +987,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
989
987
 
990
988
  #### Returns
991
989
 
992
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
990
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
993
991
 
994
992
  #### Inherited from
995
993
 
@@ -1056,7 +1054,7 @@ ___
1056
1054
 
1057
1055
  ### removeAllListeners
1058
1056
 
1059
- ▸ **removeAllListeners**(`event?`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1057
+ ▸ **removeAllListeners**(`event?`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1060
1058
 
1061
1059
  Removes all listeners, or those of the specified `eventName`.
1062
1060
 
@@ -1076,7 +1074,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
1076
1074
 
1077
1075
  #### Returns
1078
1076
 
1079
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1077
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1080
1078
 
1081
1079
  #### Inherited from
1082
1080
 
@@ -1090,7 +1088,7 @@ ___
1090
1088
 
1091
1089
  ### removeListener
1092
1090
 
1093
- ▸ **removeListener**(`eventName`, `listener`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1091
+ ▸ **removeListener**(`eventName`, `listener`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1094
1092
 
1095
1093
  Removes the specified `listener` from the listener array for the event named`eventName`.
1096
1094
 
@@ -1180,7 +1178,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
1180
1178
 
1181
1179
  #### Returns
1182
1180
 
1183
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1181
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1184
1182
 
1185
1183
  #### Inherited from
1186
1184
 
@@ -1194,7 +1192,7 @@ ___
1194
1192
 
1195
1193
  ### setMaxListeners
1196
1194
 
1197
- ▸ **setMaxListeners**(`n`): [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1195
+ ▸ **setMaxListeners**(`n`): [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1198
1196
 
1199
1197
  By default `EventEmitter`s will print a warning if more than `10` listeners are
1200
1198
  added for a particular event. This is a useful default that helps finding
@@ -1213,7 +1211,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
1213
1211
 
1214
1212
  #### Returns
1215
1213
 
1216
- [`Application`](Application.Application-1.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1214
+ [`Application`](Application.md)<`TConfig`, `TAuthToken`, `TDBConfig`, `TDBConnectionAPI`\>
1217
1215
 
1218
1216
  #### Inherited from
1219
1217
 
@@ -1235,7 +1233,7 @@ Sets the TokenManager to be used for authentication.
1235
1233
 
1236
1234
  | Name | Type |
1237
1235
  | :------ | :------ |
1238
- | `tokenManager` | [`TokenManager`](TokenManager.TokenManager-1.md)<`TAuthToken`\> |
1236
+ | `tokenManager` | [`TokenManager`](TokenManager.md)<`TAuthToken`\> |
1239
1237
 
1240
1238
  #### Returns
1241
1239
 
@@ -1243,7 +1241,7 @@ Sets the TokenManager to be used for authentication.
1243
1241
 
1244
1242
  #### Defined in
1245
1243
 
1246
- [src/Application.ts:331](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L331)
1244
+ [src/Application.ts:331](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L331)
1247
1245
 
1248
1246
  ___
1249
1247
 
@@ -1259,7 +1257,7 @@ true if the Application should bind to an IP address
1259
1257
 
1260
1258
  #### Defined in
1261
1259
 
1262
- [src/Application.ts:316](https://github.com/breautek/storm/blob/6ea3887/src/Application.ts#L316)
1260
+ [src/Application.ts:316](https://github.com/breautek/storm/blob/186ee78/src/Application.ts#L316)
1263
1261
 
1264
1262
  ___
1265
1263
 
@@ -1,9 +1,7 @@
1
- [@breautek/storm](../README.md) / [BackendAuthenticationMiddleware](../modules/BackendAuthenticationMiddleware.md) / BackendAuthenticationMiddleware
1
+ [@breautek/storm](../README.md) / BackendAuthenticationMiddleware
2
2
 
3
3
  # Class: BackendAuthenticationMiddleware
4
4
 
5
- [BackendAuthenticationMiddleware](../modules/BackendAuthenticationMiddleware.md).BackendAuthenticationMiddleware
6
-
7
5
  A base authentication strategy that handles 90% of the authentication process.
8
6
  This will verify that the token hasn't been manipulated or tainted.
9
7
  The authenticate API must be implemented by subclasses to further validate the token data
@@ -13,11 +11,11 @@ for their specific use cases.
13
11
 
14
12
  ### Constructors
15
13
 
16
- - [constructor](BackendAuthenticationMiddleware.BackendAuthenticationMiddleware-1.md#constructor)
14
+ - [constructor](BackendAuthenticationMiddleware.md#constructor)
17
15
 
18
16
  ### Methods
19
17
 
20
- - [execute](BackendAuthenticationMiddleware.BackendAuthenticationMiddleware-1.md#execute)
18
+ - [execute](BackendAuthenticationMiddleware.md#execute)
21
19
 
22
20
  ## Constructors
23
21
 
@@ -27,7 +25,7 @@ for their specific use cases.
27
25
 
28
26
  #### Defined in
29
27
 
30
- [src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/6ea3887/src/BackendAuthenticationMiddleware.ts#L35)
28
+ [src/BackendAuthenticationMiddleware.ts:35](https://github.com/breautek/storm/blob/186ee78/src/BackendAuthenticationMiddleware.ts#L35)
31
29
 
32
30
  ## Methods
33
31
 
@@ -39,7 +37,7 @@ for their specific use cases.
39
37
 
40
38
  | Name | Type | Description |
41
39
  | :------ | :------ | :------ |
42
- | `request` | [`Request`](Request.Request-1.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.IAuthTokenData-1.md)\> | |
40
+ | `request` | [`Request`](Request.md)<`any`, [`IAuthTokenData`](../interfaces/IAuthTokenData.md)\> | |
43
41
  | `options?` | `any` | Arbituary object containing any relevant information used for authentication. |
44
42
 
45
43
  #### Returns
@@ -48,4 +46,4 @@ for their specific use cases.
48
46
 
49
47
  #### Defined in
50
48
 
51
- [src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/6ea3887/src/BackendAuthenticationMiddleware.ts#L46)
49
+ [src/BackendAuthenticationMiddleware.ts:46](https://github.com/breautek/storm/blob/186ee78/src/BackendAuthenticationMiddleware.ts#L46)