egg 4.0.10 → 4.1.0-beta.3

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 (291) hide show
  1. package/README.md +4 -22
  2. package/dist/agent.d.ts +8 -0
  3. package/dist/agent.js +11 -0
  4. package/dist/app/extend/context.d.ts +207 -0
  5. package/dist/app/extend/context.js +244 -0
  6. package/{src/app/extend/helper.ts → dist/app/extend/helper.d.ts} +8 -10
  7. package/dist/app/extend/helper.js +47 -0
  8. package/dist/app/extend/request.d.ts +145 -0
  9. package/dist/app/extend/request.js +226 -0
  10. package/{src/app/extend/response.ts → dist/app/extend/response.d.ts} +7 -16
  11. package/dist/app/extend/response.js +36 -0
  12. package/dist/app/middleware/body_parser.d.ts +2 -0
  13. package/dist/app/middleware/body_parser.js +7 -0
  14. package/dist/app/middleware/meta.d.ts +11 -0
  15. package/dist/app/middleware/meta.js +14 -0
  16. package/dist/app/middleware/notfound.d.ts +11 -0
  17. package/dist/app/middleware/notfound.js +26 -0
  18. package/dist/app/middleware/override_method.d.ts +2 -0
  19. package/dist/app/middleware/override_method.js +7 -0
  20. package/dist/app/middleware/site_file.d.ts +13 -0
  21. package/dist/app/middleware/site_file.js +38 -0
  22. package/dist/config/config.default.d.ts +13 -0
  23. package/dist/config/config.default.js +257 -0
  24. package/dist/config/config.local.d.ts +10 -0
  25. package/dist/config/config.local.js +7 -0
  26. package/dist/config/config.unittest.d.ts +9 -0
  27. package/dist/config/config.unittest.js +10 -0
  28. package/{src/config/plugin.ts → dist/config/plugin.d.ts} +40 -48
  29. package/dist/config/plugin.js +54 -0
  30. package/dist/index.d.ts +19 -0
  31. package/dist/index.js +21 -0
  32. package/dist/lib/agent.d.ts +22 -0
  33. package/dist/lib/agent.js +56 -0
  34. package/dist/lib/application.d.ts +71 -0
  35. package/dist/lib/application.js +209 -0
  36. package/dist/lib/core/base_context_class.d.ts +23 -0
  37. package/dist/lib/core/base_context_class.js +19 -0
  38. package/dist/lib/core/base_context_logger.d.ts +40 -0
  39. package/dist/lib/core/base_context_logger.js +58 -0
  40. package/dist/lib/core/base_hook_class.d.ts +18 -0
  41. package/dist/lib/core/base_hook_class.js +26 -0
  42. package/dist/lib/core/context_httpclient.d.ts +21 -0
  43. package/dist/lib/core/context_httpclient.js +29 -0
  44. package/dist/lib/core/httpclient.d.ts +17 -0
  45. package/dist/lib/core/httpclient.js +36 -0
  46. package/dist/lib/core/logger.d.ts +7 -0
  47. package/dist/lib/core/logger.js +31 -0
  48. package/{src/lib/core/messenger/IMessenger.ts → dist/lib/core/messenger/IMessenger.d.ts} +6 -10
  49. package/dist/lib/core/messenger/IMessenger.js +1 -0
  50. package/dist/lib/core/messenger/base.d.ts +12 -0
  51. package/dist/lib/core/messenger/base.js +29 -0
  52. package/dist/lib/core/messenger/index.d.ts +11 -0
  53. package/dist/lib/core/messenger/index.js +13 -0
  54. package/dist/lib/core/messenger/ipc.d.ts +63 -0
  55. package/dist/lib/core/messenger/ipc.js +122 -0
  56. package/dist/lib/core/messenger/local.d.ts +65 -0
  57. package/dist/lib/core/messenger/local.js +126 -0
  58. package/dist/lib/core/utils.d.ts +5 -0
  59. package/dist/lib/core/utils.js +48 -0
  60. package/dist/lib/egg.d.ts +306 -0
  61. package/dist/lib/egg.js +512 -0
  62. package/dist/lib/error/CookieLimitExceedError.d.ts +8 -0
  63. package/dist/lib/error/CookieLimitExceedError.js +15 -0
  64. package/dist/lib/error/MessageUnhandledRejectionError.d.ts +8 -0
  65. package/dist/lib/error/MessageUnhandledRejectionError.js +15 -0
  66. package/dist/lib/error/index.d.ts +3 -0
  67. package/dist/lib/error/index.js +4 -0
  68. package/dist/lib/loader/AgentWorkerLoader.d.ts +17 -0
  69. package/dist/lib/loader/AgentWorkerLoader.js +24 -0
  70. package/dist/lib/loader/AppWorkerLoader.d.ts +22 -0
  71. package/dist/lib/loader/AppWorkerLoader.js +37 -0
  72. package/dist/lib/loader/EggApplicationLoader.d.ts +8 -0
  73. package/dist/lib/loader/EggApplicationLoader.js +7 -0
  74. package/dist/lib/loader/index.d.ts +4 -0
  75. package/dist/lib/loader/index.js +5 -0
  76. package/dist/lib/start.d.ts +28 -0
  77. package/dist/lib/start.js +36 -0
  78. package/{src/lib/types.ts → dist/lib/types.d.ts} +45 -94
  79. package/dist/lib/types.js +14 -0
  80. package/dist/lib/utils.d.ts +5 -0
  81. package/dist/lib/utils.js +14 -0
  82. package/dist/urllib.d.ts +1 -0
  83. package/dist/urllib.js +3 -0
  84. package/package.json +76 -97
  85. package/README.zh-CN.md +0 -61
  86. package/dist/commonjs/agent.d.ts +0 -4
  87. package/dist/commonjs/agent.js +0 -10
  88. package/dist/commonjs/app/extend/context.d.ts +0 -204
  89. package/dist/commonjs/app/extend/context.js +0 -262
  90. package/dist/commonjs/app/extend/helper.d.ts +0 -37
  91. package/dist/commonjs/app/extend/helper.js +0 -49
  92. package/dist/commonjs/app/extend/request.d.ts +0 -141
  93. package/dist/commonjs/app/extend/request.js +0 -270
  94. package/dist/commonjs/app/extend/response.d.ts +0 -31
  95. package/dist/commonjs/app/extend/response.js +0 -37
  96. package/dist/commonjs/app/middleware/body_parser.d.ts +0 -2
  97. package/dist/commonjs/app/middleware/body_parser.js +0 -8
  98. package/dist/commonjs/app/middleware/meta.d.ts +0 -10
  99. package/dist/commonjs/app/middleware/meta.js +0 -22
  100. package/dist/commonjs/app/middleware/notfound.d.ts +0 -7
  101. package/dist/commonjs/app/middleware/notfound.js +0 -31
  102. package/dist/commonjs/app/middleware/override_method.d.ts +0 -2
  103. package/dist/commonjs/app/middleware/override_method.js +0 -8
  104. package/dist/commonjs/app/middleware/site_file.d.ts +0 -9
  105. package/dist/commonjs/app/middleware/site_file.js +0 -58
  106. package/dist/commonjs/config/config.default.d.ts +0 -9
  107. package/dist/commonjs/config/config.default.js +0 -379
  108. package/dist/commonjs/config/config.local.d.ts +0 -8
  109. package/dist/commonjs/config/config.local.js +0 -12
  110. package/dist/commonjs/config/config.unittest.d.ts +0 -7
  111. package/dist/commonjs/config/config.unittest.js +0 -11
  112. package/dist/commonjs/config/favicon.png +0 -0
  113. package/dist/commonjs/config/plugin.d.ts +0 -122
  114. package/dist/commonjs/config/plugin.js +0 -124
  115. package/dist/commonjs/index.d.ts +0 -69
  116. package/dist/commonjs/index.js +0 -83
  117. package/dist/commonjs/lib/agent.d.ts +0 -19
  118. package/dist/commonjs/lib/agent.js +0 -58
  119. package/dist/commonjs/lib/application.d.ts +0 -67
  120. package/dist/commonjs/lib/application.js +0 -266
  121. package/dist/commonjs/lib/core/base_context_class.d.ts +0 -17
  122. package/dist/commonjs/lib/core/base_context_class.js +0 -21
  123. package/dist/commonjs/lib/core/base_context_logger.d.ts +0 -36
  124. package/dist/commonjs/lib/core/base_context_logger.js +0 -64
  125. package/dist/commonjs/lib/core/base_hook_class.d.ts +0 -11
  126. package/dist/commonjs/lib/core/base_hook_class.js +0 -29
  127. package/dist/commonjs/lib/core/context_httpclient.d.ts +0 -16
  128. package/dist/commonjs/lib/core/context_httpclient.js +0 -30
  129. package/dist/commonjs/lib/core/httpclient.d.ts +0 -14
  130. package/dist/commonjs/lib/core/httpclient.js +0 -42
  131. package/dist/commonjs/lib/core/logger.d.ts +0 -3
  132. package/dist/commonjs/lib/core/logger.js +0 -40
  133. package/dist/commonjs/lib/core/messenger/IMessenger.d.ts +0 -50
  134. package/dist/commonjs/lib/core/messenger/IMessenger.js +0 -3
  135. package/dist/commonjs/lib/core/messenger/base.d.ts +0 -8
  136. package/dist/commonjs/lib/core/messenger/base.js +0 -31
  137. package/dist/commonjs/lib/core/messenger/index.d.ts +0 -7
  138. package/dist/commonjs/lib/core/messenger/index.js +0 -15
  139. package/dist/commonjs/lib/core/messenger/ipc.d.ts +0 -58
  140. package/dist/commonjs/lib/core/messenger/ipc.js +0 -135
  141. package/dist/commonjs/lib/core/messenger/local.d.ts +0 -60
  142. package/dist/commonjs/lib/core/messenger/local.js +0 -132
  143. package/dist/commonjs/lib/core/utils.d.ts +0 -2
  144. package/dist/commonjs/lib/core/utils.js +0 -77
  145. package/dist/commonjs/lib/egg.d.ts +0 -305
  146. package/dist/commonjs/lib/egg.js +0 -628
  147. package/dist/commonjs/lib/error/CookieLimitExceedError.d.ts +0 -5
  148. package/dist/commonjs/lib/error/CookieLimitExceedError.js +0 -16
  149. package/dist/commonjs/lib/error/MessageUnhandledRejectionError.d.ts +0 -5
  150. package/dist/commonjs/lib/error/MessageUnhandledRejectionError.js +0 -16
  151. package/dist/commonjs/lib/error/index.d.ts +0 -2
  152. package/dist/commonjs/lib/error/index.js +0 -19
  153. package/dist/commonjs/lib/loader/AgentWorkerLoader.d.ts +0 -12
  154. package/dist/commonjs/lib/loader/AgentWorkerLoader.js +0 -24
  155. package/dist/commonjs/lib/loader/AppWorkerLoader.d.ts +0 -17
  156. package/dist/commonjs/lib/loader/AppWorkerLoader.js +0 -43
  157. package/dist/commonjs/lib/loader/EggApplicationLoader.d.ts +0 -4
  158. package/dist/commonjs/lib/loader/EggApplicationLoader.js +0 -8
  159. package/dist/commonjs/lib/loader/index.d.ts +0 -3
  160. package/dist/commonjs/lib/loader/index.js +0 -22
  161. package/dist/commonjs/lib/start.d.ts +0 -24
  162. package/dist/commonjs/lib/start.js +0 -49
  163. package/dist/commonjs/lib/types.d.ts +0 -257
  164. package/dist/commonjs/lib/types.js +0 -16
  165. package/dist/commonjs/lib/utils.d.ts +0 -2
  166. package/dist/commonjs/lib/utils.js +0 -21
  167. package/dist/commonjs/package.json +0 -3
  168. package/dist/commonjs/urllib.d.ts +0 -1
  169. package/dist/commonjs/urllib.js +0 -18
  170. package/dist/esm/agent.d.ts +0 -4
  171. package/dist/esm/agent.js +0 -7
  172. package/dist/esm/app/extend/context.d.ts +0 -204
  173. package/dist/esm/app/extend/context.js +0 -259
  174. package/dist/esm/app/extend/helper.d.ts +0 -37
  175. package/dist/esm/app/extend/helper.js +0 -43
  176. package/dist/esm/app/extend/request.d.ts +0 -141
  177. package/dist/esm/app/extend/request.js +0 -264
  178. package/dist/esm/app/extend/response.d.ts +0 -31
  179. package/dist/esm/app/extend/response.js +0 -34
  180. package/dist/esm/app/middleware/body_parser.d.ts +0 -2
  181. package/dist/esm/app/middleware/body_parser.js +0 -3
  182. package/dist/esm/app/middleware/meta.d.ts +0 -10
  183. package/dist/esm/app/middleware/meta.js +0 -20
  184. package/dist/esm/app/middleware/notfound.d.ts +0 -7
  185. package/dist/esm/app/middleware/notfound.js +0 -29
  186. package/dist/esm/app/middleware/override_method.d.ts +0 -2
  187. package/dist/esm/app/middleware/override_method.js +0 -3
  188. package/dist/esm/app/middleware/site_file.d.ts +0 -9
  189. package/dist/esm/app/middleware/site_file.js +0 -53
  190. package/dist/esm/config/config.default.d.ts +0 -9
  191. package/dist/esm/config/config.default.js +0 -374
  192. package/dist/esm/config/config.local.d.ts +0 -8
  193. package/dist/esm/config/config.local.js +0 -10
  194. package/dist/esm/config/config.unittest.d.ts +0 -7
  195. package/dist/esm/config/config.unittest.js +0 -9
  196. package/dist/esm/config/favicon.png +0 -0
  197. package/dist/esm/config/plugin.d.ts +0 -122
  198. package/dist/esm/config/plugin.js +0 -122
  199. package/dist/esm/index.d.ts +0 -69
  200. package/dist/esm/index.js +0 -73
  201. package/dist/esm/lib/agent.d.ts +0 -19
  202. package/dist/esm/lib/agent.js +0 -54
  203. package/dist/esm/lib/application.d.ts +0 -67
  204. package/dist/esm/lib/application.js +0 -259
  205. package/dist/esm/lib/core/base_context_class.d.ts +0 -17
  206. package/dist/esm/lib/core/base_context_class.js +0 -17
  207. package/dist/esm/lib/core/base_context_logger.d.ts +0 -36
  208. package/dist/esm/lib/core/base_context_logger.js +0 -60
  209. package/dist/esm/lib/core/base_hook_class.d.ts +0 -11
  210. package/dist/esm/lib/core/base_hook_class.js +0 -22
  211. package/dist/esm/lib/core/context_httpclient.d.ts +0 -16
  212. package/dist/esm/lib/core/context_httpclient.js +0 -26
  213. package/dist/esm/lib/core/httpclient.d.ts +0 -14
  214. package/dist/esm/lib/core/httpclient.js +0 -38
  215. package/dist/esm/lib/core/logger.d.ts +0 -3
  216. package/dist/esm/lib/core/logger.js +0 -37
  217. package/dist/esm/lib/core/messenger/IMessenger.d.ts +0 -50
  218. package/dist/esm/lib/core/messenger/IMessenger.js +0 -2
  219. package/dist/esm/lib/core/messenger/base.d.ts +0 -8
  220. package/dist/esm/lib/core/messenger/base.js +0 -27
  221. package/dist/esm/lib/core/messenger/index.d.ts +0 -7
  222. package/dist/esm/lib/core/messenger/index.js +0 -12
  223. package/dist/esm/lib/core/messenger/ipc.d.ts +0 -58
  224. package/dist/esm/lib/core/messenger/ipc.js +0 -128
  225. package/dist/esm/lib/core/messenger/local.d.ts +0 -60
  226. package/dist/esm/lib/core/messenger/local.js +0 -128
  227. package/dist/esm/lib/core/utils.d.ts +0 -2
  228. package/dist/esm/lib/core/utils.js +0 -70
  229. package/dist/esm/lib/egg.d.ts +0 -305
  230. package/dist/esm/lib/egg.js +0 -586
  231. package/dist/esm/lib/error/CookieLimitExceedError.d.ts +0 -5
  232. package/dist/esm/lib/error/CookieLimitExceedError.js +0 -12
  233. package/dist/esm/lib/error/MessageUnhandledRejectionError.d.ts +0 -5
  234. package/dist/esm/lib/error/MessageUnhandledRejectionError.js +0 -12
  235. package/dist/esm/lib/error/index.d.ts +0 -2
  236. package/dist/esm/lib/error/index.js +0 -3
  237. package/dist/esm/lib/loader/AgentWorkerLoader.d.ts +0 -12
  238. package/dist/esm/lib/loader/AgentWorkerLoader.js +0 -20
  239. package/dist/esm/lib/loader/AppWorkerLoader.d.ts +0 -17
  240. package/dist/esm/lib/loader/AppWorkerLoader.js +0 -39
  241. package/dist/esm/lib/loader/EggApplicationLoader.d.ts +0 -4
  242. package/dist/esm/lib/loader/EggApplicationLoader.js +0 -4
  243. package/dist/esm/lib/loader/index.d.ts +0 -3
  244. package/dist/esm/lib/loader/index.js +0 -4
  245. package/dist/esm/lib/start.d.ts +0 -24
  246. package/dist/esm/lib/start.js +0 -43
  247. package/dist/esm/lib/types.d.ts +0 -257
  248. package/dist/esm/lib/types.js +0 -14
  249. package/dist/esm/lib/utils.d.ts +0 -2
  250. package/dist/esm/lib/utils.js +0 -14
  251. package/dist/esm/package.json +0 -3
  252. package/dist/esm/urllib.d.ts +0 -1
  253. package/dist/esm/urllib.js +0 -2
  254. package/dist/package.json +0 -4
  255. package/src/agent.ts +0 -7
  256. package/src/app/extend/context.ts +0 -332
  257. package/src/app/extend/request.ts +0 -300
  258. package/src/app/middleware/body_parser.ts +0 -3
  259. package/src/app/middleware/meta.ts +0 -27
  260. package/src/app/middleware/notfound.ts +0 -41
  261. package/src/app/middleware/override_method.ts +0 -3
  262. package/src/app/middleware/site_file.ts +0 -68
  263. package/src/config/config.default.ts +0 -404
  264. package/src/config/config.local.ts +0 -11
  265. package/src/config/config.unittest.ts +0 -10
  266. package/src/config/favicon.png +0 -0
  267. package/src/index.ts +0 -120
  268. package/src/lib/agent.ts +0 -66
  269. package/src/lib/application.ts +0 -308
  270. package/src/lib/core/base_context_class.ts +0 -24
  271. package/src/lib/core/base_context_logger.ts +0 -67
  272. package/src/lib/core/base_hook_class.ts +0 -30
  273. package/src/lib/core/context_httpclient.ts +0 -33
  274. package/src/lib/core/httpclient.ts +0 -64
  275. package/src/lib/core/logger.ts +0 -42
  276. package/src/lib/core/messenger/base.ts +0 -30
  277. package/src/lib/core/messenger/index.ts +0 -16
  278. package/src/lib/core/messenger/ipc.ts +0 -146
  279. package/src/lib/core/messenger/local.ts +0 -147
  280. package/src/lib/core/utils.ts +0 -77
  281. package/src/lib/egg.ts +0 -705
  282. package/src/lib/error/CookieLimitExceedError.ts +0 -12
  283. package/src/lib/error/MessageUnhandledRejectionError.ts +0 -12
  284. package/src/lib/error/index.ts +0 -2
  285. package/src/lib/loader/AgentWorkerLoader.ts +0 -21
  286. package/src/lib/loader/AppWorkerLoader.ts +0 -42
  287. package/src/lib/loader/EggApplicationLoader.ts +0 -5
  288. package/src/lib/loader/index.ts +0 -3
  289. package/src/lib/start.ts +0 -66
  290. package/src/lib/utils.ts +0 -15
  291. package/src/urllib.ts +0 -1
@@ -1,204 +0,0 @@
1
- import { Context as EggCoreContext, Router } from '@eggjs/core';
2
- import type { Cookies as ContextCookies } from '@eggjs/cookies';
3
- import type { EggLogger } from 'egg-logger';
4
- import type { Application } from '../../lib/application.js';
5
- import type { HttpClientRequestURL, HttpClientRequestOptions, HttpClient } from '../../lib/core/httpclient.js';
6
- import type { BaseContextClass } from '../../lib//core/base_context_class.js';
7
- import type Request from './request.js';
8
- import type Response from './response.js';
9
- import type Helper from './helper.js';
10
- interface Cookies extends ContextCookies {
11
- request: any;
12
- response: any;
13
- }
14
- export default class Context extends EggCoreContext {
15
- app: Application;
16
- request: Request;
17
- response: Response;
18
- service: BaseContextClass;
19
- proxy: any;
20
- /**
21
- * Request start time
22
- * @member {Number} Context#starttime
23
- */
24
- starttime: number;
25
- /**
26
- * Request start timer using `performance.now()`
27
- * @member {Number} Context#performanceStarttime
28
- */
29
- performanceStarttime: number;
30
- /**
31
- * Get the current visitor's cookies.
32
- */
33
- get cookies(): Cookies;
34
- /**
35
- * Get a wrapper httpclient instance contain ctx in the hold request process
36
- *
37
- * @return {HttpClient} the wrapper httpclient instance
38
- */
39
- get httpclient(): HttpClient;
40
- /**
41
- * Alias to {@link Context#httpclient}
42
- */
43
- get httpClient(): HttpClient;
44
- /**
45
- * Shortcut for httpclient.curl
46
- *
47
- * @function Context#curl
48
- * @param {String|Object} url - request url address.
49
- * @param {Object} [options] - options for request.
50
- * @return {Object} see {@link ContextHttpClient#curl}
51
- */
52
- curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
53
- /**
54
- * Alias to {@link Application#router}
55
- *
56
- * @member {Router} Context#router
57
- * @since 1.0.0
58
- * @example
59
- * ```js
60
- * this.router.pathFor('post', { id: 12 });
61
- * ```
62
- */
63
- get router(): Router;
64
- /**
65
- * Set router to Context, only use on EggRouter
66
- * @param {Router} val router instance
67
- */
68
- set router(val: Router);
69
- /**
70
- * Get helper instance from {@link Application#Helper}
71
- *
72
- * @member {Helper} Context#helper
73
- * @since 1.0.0
74
- */
75
- get helper(): Helper;
76
- /**
77
- * Wrap app.loggers with context information,
78
- * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
79
- *
80
- * @param {String} name - logger name
81
- */
82
- getLogger(name: string): EggLogger;
83
- /**
84
- * Logger for Application
85
- *
86
- * @member {Logger} Context#logger
87
- * @since 1.0.0
88
- * @example
89
- * ```js
90
- * this.logger.info('some request data: %j', this.request.body);
91
- * this.logger.warn('WARNING!!!!');
92
- * ```
93
- */
94
- get logger(): EggLogger;
95
- /**
96
- * Logger for frameworks and plugins
97
- *
98
- * @member {Logger} Context#coreLogger
99
- * @since 1.0.0
100
- */
101
- get coreLogger(): EggLogger;
102
- /**
103
- * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
104
- * which will be used as data when view is rendering.
105
- * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
106
- *
107
- * when you set locals, only object is available
108
- *
109
- * ```js
110
- * this.locals = {
111
- * a: 1
112
- * };
113
- * this.locals = {
114
- * b: 1
115
- * };
116
- * this.locals.c = 1;
117
- * console.log(this.locals);
118
- * {
119
- * a: 1,
120
- * b: 1,
121
- * c: 1,
122
- * };
123
- * ```
124
- *
125
- * `ctx.locals` has cache, it only merges `app.locals` once in one request.
126
- *
127
- * @member {Object} Context#locals
128
- */
129
- get locals(): Record<string, any>;
130
- set locals(val: Record<string, any>);
131
- /**
132
- * alias to {@link Context#locals}, compatible with koa that use this variable
133
- * @member {Object} state
134
- * @see Context#locals
135
- */
136
- get state(): Record<string, any>;
137
- set state(val: Record<string, any>);
138
- /**
139
- * Run async function in the background
140
- * @param {Function} scope - the first args is ctx
141
- * ```js
142
- * this.body = 'hi';
143
- *
144
- * this.runInBackground(async ctx => {
145
- * await ctx.mysql.query(sql);
146
- * await ctx.curl(url);
147
- * });
148
- * ```
149
- */
150
- runInBackground(scope: (ctx: Context) => Promise<void>, taskName?: string): void;
151
- _runInBackground(scope: (ctx: Context) => Promise<void>, taskName: string): Promise<void>;
152
- /**
153
- * @member {Boolean} Context#acceptJSON
154
- * @see Request#acceptJSON
155
- * @since 1.0.0
156
- */
157
- get acceptJSON(): boolean;
158
- get query(): Record<string, string>;
159
- /**
160
- * @member {Array} Context#queries
161
- * @see Request#queries
162
- * @since 1.0.0
163
- */
164
- get queries(): Record<string, string[]>;
165
- /**
166
- * @member {string} Context#ip
167
- * @see Request#ip
168
- * @since 1.0.0
169
- */
170
- get ip(): string;
171
- set ip(val: string);
172
- /**
173
- * @member {Number} Context#realStatus
174
- * @see Response#realStatus
175
- * @since 1.0.0
176
- */
177
- get realStatus(): number;
178
- set realStatus(val: number);
179
- }
180
- declare module '@eggjs/core' {
181
- interface Context {
182
- proxy: any;
183
- performanceStarttime: number;
184
- starttime: number;
185
- runInBackground(scope: (ctx: Context) => Promise<void>, taskName?: string): void;
186
- _runInBackground(scope: (ctx: Context) => Promise<void>, taskName: string): void;
187
- get acceptJSON(): boolean;
188
- get query(): Record<string, string>;
189
- get queries(): Record<string, string[]>;
190
- curl(url: HttpClientRequestURL, options?: HttpClientRequestOptions): ReturnType<HttpClient['request']>;
191
- get router(): Router;
192
- set router(val: Router);
193
- get helper(): Helper;
194
- get httpclient(): HttpClient;
195
- get httpClient(): HttpClient;
196
- getLogger(name: string): EggLogger;
197
- get logger(): EggLogger;
198
- get coreLogger(): EggLogger;
199
- get locals(): Record<string, any>;
200
- get realStatus(): number;
201
- set realStatus(val: number);
202
- }
203
- }
204
- export {};
@@ -1,259 +0,0 @@
1
- import { assign } from 'utility';
2
- import { now, diff } from 'performance-ms';
3
- import { utils, Context as EggCoreContext, } from '@eggjs/core';
4
- const HELPER = Symbol('ctx helper');
5
- const LOCALS = Symbol('ctx locals');
6
- const LOCALS_LIST = Symbol('ctx localsList');
7
- const COOKIES = Symbol('ctx cookies');
8
- const CONTEXT_HTTPCLIENT = Symbol('ctx httpclient');
9
- const CONTEXT_ROUTER = Symbol('ctx router');
10
- export default class Context extends EggCoreContext {
11
- /**
12
- * Request start time
13
- * @member {Number} Context#starttime
14
- */
15
- starttime;
16
- /**
17
- * Request start timer using `performance.now()`
18
- * @member {Number} Context#performanceStarttime
19
- */
20
- performanceStarttime;
21
- /**
22
- * Get the current visitor's cookies.
23
- */
24
- get cookies() {
25
- let cookies = this[COOKIES];
26
- if (!cookies) {
27
- this[COOKIES] = cookies = new this.app.ContextCookies(this, this.app.keys, this.app.config.cookies);
28
- }
29
- return cookies;
30
- }
31
- /**
32
- * Get a wrapper httpclient instance contain ctx in the hold request process
33
- *
34
- * @return {HttpClient} the wrapper httpclient instance
35
- */
36
- get httpclient() {
37
- if (!this[CONTEXT_HTTPCLIENT]) {
38
- this[CONTEXT_HTTPCLIENT] = new this.app.ContextHttpClient(this);
39
- }
40
- return this[CONTEXT_HTTPCLIENT];
41
- }
42
- /**
43
- * Alias to {@link Context#httpclient}
44
- */
45
- get httpClient() {
46
- return this.httpclient;
47
- }
48
- /**
49
- * Shortcut for httpclient.curl
50
- *
51
- * @function Context#curl
52
- * @param {String|Object} url - request url address.
53
- * @param {Object} [options] - options for request.
54
- * @return {Object} see {@link ContextHttpClient#curl}
55
- */
56
- async curl(url, options) {
57
- return await this.httpclient.curl(url, options);
58
- }
59
- /**
60
- * Alias to {@link Application#router}
61
- *
62
- * @member {Router} Context#router
63
- * @since 1.0.0
64
- * @example
65
- * ```js
66
- * this.router.pathFor('post', { id: 12 });
67
- * ```
68
- */
69
- get router() {
70
- if (this[CONTEXT_ROUTER]) {
71
- return this[CONTEXT_ROUTER];
72
- }
73
- return this.app.router;
74
- }
75
- /**
76
- * Set router to Context, only use on EggRouter
77
- * @param {Router} val router instance
78
- */
79
- set router(val) {
80
- this[CONTEXT_ROUTER] = val;
81
- }
82
- /**
83
- * Get helper instance from {@link Application#Helper}
84
- *
85
- * @member {Helper} Context#helper
86
- * @since 1.0.0
87
- */
88
- get helper() {
89
- if (!this[HELPER]) {
90
- this[HELPER] = new this.app.Helper(this);
91
- }
92
- return this[HELPER];
93
- }
94
- /**
95
- * Wrap app.loggers with context information,
96
- * if a custom logger is defined by naming aLogger, then you can `ctx.getLogger('aLogger')`
97
- *
98
- * @param {String} name - logger name
99
- */
100
- getLogger(name) {
101
- return this.app.getLogger(name);
102
- }
103
- /**
104
- * Logger for Application
105
- *
106
- * @member {Logger} Context#logger
107
- * @since 1.0.0
108
- * @example
109
- * ```js
110
- * this.logger.info('some request data: %j', this.request.body);
111
- * this.logger.warn('WARNING!!!!');
112
- * ```
113
- */
114
- get logger() {
115
- return this.getLogger('logger');
116
- }
117
- /**
118
- * Logger for frameworks and plugins
119
- *
120
- * @member {Logger} Context#coreLogger
121
- * @since 1.0.0
122
- */
123
- get coreLogger() {
124
- return this.getLogger('coreLogger');
125
- }
126
- /**
127
- * locals is an object for view, you can use `app.locals` and `ctx.locals` to set variables,
128
- * which will be used as data when view is rendering.
129
- * The difference between `app.locals` and `ctx.locals` is the context level, `app.locals` is global level, and `ctx.locals` is request level. when you get `ctx.locals`, it will merge `app.locals`.
130
- *
131
- * when you set locals, only object is available
132
- *
133
- * ```js
134
- * this.locals = {
135
- * a: 1
136
- * };
137
- * this.locals = {
138
- * b: 1
139
- * };
140
- * this.locals.c = 1;
141
- * console.log(this.locals);
142
- * {
143
- * a: 1,
144
- * b: 1,
145
- * c: 1,
146
- * };
147
- * ```
148
- *
149
- * `ctx.locals` has cache, it only merges `app.locals` once in one request.
150
- *
151
- * @member {Object} Context#locals
152
- */
153
- get locals() {
154
- if (!this[LOCALS]) {
155
- this[LOCALS] = assign({}, this.app.locals);
156
- }
157
- if (Array.isArray(this[LOCALS_LIST]) && this[LOCALS_LIST].length > 0) {
158
- assign(this[LOCALS], this[LOCALS_LIST]);
159
- this[LOCALS_LIST] = null;
160
- }
161
- return this[LOCALS];
162
- }
163
- set locals(val) {
164
- const localsList = this[LOCALS_LIST] ?? [];
165
- localsList.push(val);
166
- this[LOCALS_LIST] = localsList;
167
- }
168
- /**
169
- * alias to {@link Context#locals}, compatible with koa that use this variable
170
- * @member {Object} state
171
- * @see Context#locals
172
- */
173
- get state() {
174
- return this.locals;
175
- }
176
- set state(val) {
177
- this.locals = val;
178
- }
179
- /**
180
- * Run async function in the background
181
- * @param {Function} scope - the first args is ctx
182
- * ```js
183
- * this.body = 'hi';
184
- *
185
- * this.runInBackground(async ctx => {
186
- * await ctx.mysql.query(sql);
187
- * await ctx.curl(url);
188
- * });
189
- * ```
190
- */
191
- runInBackground(scope, taskName) {
192
- // try to use custom function name first
193
- if (!taskName) {
194
- taskName = Reflect.get(scope, '_name') || scope.name || utils.getCalleeFromStack(true);
195
- }
196
- // use setImmediate to ensure all sync logic will run async
197
- setImmediate(() => {
198
- this._runInBackground(scope, taskName);
199
- });
200
- }
201
- // let plugins or frameworks to reuse _runInBackground in some cases.
202
- // e.g.: https://github.com/eggjs/egg-mock/pull/78
203
- async _runInBackground(scope, taskName) {
204
- const startTime = now();
205
- try {
206
- await scope(this);
207
- this.coreLogger.info('[egg:background] task:%s success (%dms)', taskName, diff(startTime));
208
- }
209
- catch (err) {
210
- // background task process log
211
- this.coreLogger.info('[egg:background] task:%s fail (%dms)', taskName, diff(startTime));
212
- // emit error when promise catch, and set err.runInBackground flag
213
- err.runInBackground = true;
214
- this.app.emit('error', err, this);
215
- }
216
- }
217
- /**
218
- * @member {Boolean} Context#acceptJSON
219
- * @see Request#acceptJSON
220
- * @since 1.0.0
221
- */
222
- get acceptJSON() {
223
- return this.request.acceptJSON;
224
- }
225
- get query() {
226
- return this.request.query;
227
- }
228
- /**
229
- * @member {Array} Context#queries
230
- * @see Request#queries
231
- * @since 1.0.0
232
- */
233
- get queries() {
234
- return this.request.queries;
235
- }
236
- /**
237
- * @member {string} Context#ip
238
- * @see Request#ip
239
- * @since 1.0.0
240
- */
241
- get ip() {
242
- return this.request.ip;
243
- }
244
- set ip(val) {
245
- this.request.ip = val;
246
- }
247
- /**
248
- * @member {Number} Context#realStatus
249
- * @see Response#realStatus
250
- * @since 1.0.0
251
- */
252
- get realStatus() {
253
- return this.response.realStatus;
254
- }
255
- set realStatus(val) {
256
- this.response.realStatus = val;
257
- }
258
- }
259
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLFNBQVMsQ0FBQztBQUNqQyxPQUFPLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBQzNDLE9BQU8sRUFDTCxLQUFLLEVBQUUsT0FBTyxJQUFJLGNBQWMsR0FDakMsTUFBTSxhQUFhLENBQUM7QUFZckIsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ3BDLE1BQU0sTUFBTSxHQUFHLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUNwQyxNQUFNLFdBQVcsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUM3QyxNQUFNLE9BQU8sR0FBRyxNQUFNLENBQUMsYUFBYSxDQUFDLENBQUM7QUFDdEMsTUFBTSxrQkFBa0IsR0FBRyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztBQUNwRCxNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDLENBQUM7QUFPNUMsTUFBTSxDQUFDLE9BQU8sT0FBTyxPQUFRLFNBQVEsY0FBYztJQU9qRDs7O09BR0c7SUFDSCxTQUFTLENBQVM7SUFDbEI7OztPQUdHO0lBQ0gsb0JBQW9CLENBQVM7SUFFN0I7O09BRUc7SUFDSCxJQUFJLE9BQU87UUFDVCxJQUFJLE9BQU8sR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDNUIsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO1lBQ2IsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLE9BQU8sR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUN0RyxDQUFDO1FBQ0QsT0FBTyxPQUFrQixDQUFDO0lBQzVCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxVQUFVO1FBQ1osSUFBSSxDQUFDLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxFQUFFLENBQUM7WUFDOUIsSUFBSSxDQUFDLGtCQUFrQixDQUFDLEdBQUcsSUFBSSxJQUFJLENBQUMsR0FBRyxDQUFDLGlCQUFpQixDQUFDLElBQVcsQ0FBQyxDQUFDO1FBQ3pFLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxrQkFBa0IsQ0FBZSxDQUFDO0lBQ2hELENBQUM7SUFFRDs7T0FFRztJQUNILElBQUksVUFBVTtRQUNaLE9BQU8sSUFBSSxDQUFDLFVBQVUsQ0FBQztJQUN6QixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNILEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBeUIsRUFBRSxPQUFrQztRQUN0RSxPQUFPLE1BQU0sSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ2xELENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxJQUFJLE1BQU07UUFDUixJQUFJLElBQUksQ0FBQyxjQUFjLENBQUMsRUFBRSxDQUFDO1lBQ3pCLE9BQU8sSUFBSSxDQUFDLGNBQWMsQ0FBVyxDQUFDO1FBQ3hDLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDO0lBQ3pCLENBQUM7SUFFRDs7O09BR0c7SUFDSCxJQUFJLE1BQU0sQ0FBQyxHQUFXO1FBQ3BCLElBQUksQ0FBQyxjQUFjLENBQUMsR0FBRyxHQUFHLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ2xCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxJQUFJLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLElBQVcsQ0FBQyxDQUFDO1FBQ2xELENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxNQUFNLENBQVcsQ0FBQztJQUNoQyxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxTQUFTLENBQUMsSUFBWTtRQUNwQixPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ2xDLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2xDLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILElBQUksVUFBVTtRQUNaLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUN0QyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O09BMEJHO0lBQ0gsSUFBSSxNQUFNO1FBQ1IsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ2xCLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxNQUFNLENBQUMsRUFBRSxFQUFFLElBQUksQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDN0MsQ0FBQztRQUNELElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsSUFBSSxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ3JFLE1BQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUUsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDeEMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLElBQUksQ0FBQztRQUMzQixDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUF3QixDQUFDO0lBQzdDLENBQUM7SUFFRCxJQUFJLE1BQU0sQ0FBQyxHQUFHO1FBQ1osTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBMEIsSUFBSSxFQUFFLENBQUM7UUFDcEUsVUFBVSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNyQixJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsVUFBVSxDQUFDO0lBQ2pDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxLQUFLO1FBQ1AsT0FBTyxJQUFJLENBQUMsTUFBTSxDQUFDO0lBQ3JCLENBQUM7SUFFRCxJQUFJLEtBQUssQ0FBQyxHQUFHO1FBQ1gsSUFBSSxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUM7SUFDcEIsQ0FBQztJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ0gsZUFBZSxDQUFDLEtBQXNDLEVBQUUsUUFBaUI7UUFDdkUsd0NBQXdDO1FBQ3hDLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztZQUNkLFFBQVEsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsSUFBSSxLQUFLLENBQUMsSUFBSSxJQUFJLEtBQUssQ0FBQyxrQkFBa0IsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN6RixDQUFDO1FBQ0QsMkRBQTJEO1FBQzNELFlBQVksQ0FBQyxHQUFHLEVBQUU7WUFDaEIsSUFBSSxDQUFDLGdCQUFnQixDQUFDLEtBQUssRUFBRSxRQUFTLENBQUMsQ0FBQztRQUMxQyxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRCxxRUFBcUU7SUFDckUsa0RBQWtEO0lBQ2xELEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFzQyxFQUFFLFFBQWdCO1FBQzdFLE1BQU0sU0FBUyxHQUFHLEdBQUcsRUFBRSxDQUFDO1FBQ3hCLElBQUksQ0FBQztZQUNILE1BQU0sS0FBSyxDQUFDLElBQVcsQ0FBQyxDQUFDO1lBQ3pCLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLHlDQUF5QyxFQUFFLFFBQVEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztRQUM3RixDQUFDO1FBQUMsT0FBTyxHQUFRLEVBQUUsQ0FBQztZQUNsQiw4QkFBOEI7WUFDOUIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsc0NBQXNDLEVBQUUsUUFBUSxFQUFFLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO1lBRXhGLGtFQUFrRTtZQUNsRSxHQUFHLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQztZQUMzQixJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3BDLENBQUM7SUFDSCxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILElBQUksVUFBVTtRQUNaLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUM7SUFDakMsQ0FBQztJQUVELElBQUksS0FBSztRQUNQLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUM7SUFDNUIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLE9BQU87UUFDVCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDO0lBQzlCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxFQUFFO1FBQ0osT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztJQUN6QixDQUFDO0lBRUQsSUFBSSxFQUFFLENBQUMsR0FBVztRQUNoQixJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsR0FBRyxHQUFHLENBQUM7SUFDeEIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxJQUFJLFVBQVU7UUFDWixPQUFPLElBQUksQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDO0lBQ2xDLENBQUM7SUFFRCxJQUFJLFVBQVUsQ0FBQyxHQUFXO1FBQ3hCLElBQUksQ0FBQyxRQUFRLENBQUMsVUFBVSxHQUFHLEdBQUcsQ0FBQztJQUNqQyxDQUFDO0NBQ0YifQ==
@@ -1,37 +0,0 @@
1
- import { BaseContextClass } from '../../lib/core/base_context_class.js';
2
- /**
3
- * The Helper class which can be used as utility function.
4
- * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
5
- * then you can use all method on `ctx.helper` that is a instance of Helper.
6
- */
7
- export default class Helper extends BaseContextClass {
8
- /**
9
- * Generate URL path(without host) for route. Takes the route name and a map of named params.
10
- * @function Helper#pathFor
11
- * @param {String} name - Router Name
12
- * @param {Object} params - Other params
13
- *
14
- * @example
15
- * ```js
16
- * app.get('home', '/index.htm', 'home.index');
17
- * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
18
- * => /index.htm?by=recent&limit=20
19
- * ```
20
- * @return {String} url path(without host)
21
- */
22
- pathFor(name: string, params: Record<string, any>): string;
23
- /**
24
- * Generate full URL(with host) for route. Takes the route name and a map of named params.
25
- * @function Helper#urlFor
26
- * @param {String} name - Router name
27
- * @param {Object} params - Other params
28
- * @example
29
- * ```js
30
- * app.get('home', '/index.htm', 'home.index');
31
- * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
32
- * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
33
- * ```
34
- * @return {String} full url(with host)
35
- */
36
- urlFor(name: string, params: Record<string, any>): string;
37
- }
@@ -1,43 +0,0 @@
1
- import url from 'node:url';
2
- import { BaseContextClass } from '../../lib/core/base_context_class.js';
3
- /**
4
- * The Helper class which can be used as utility function.
5
- * We support developers to extend Helper through ${baseDir}/app/extend/helper.js ,
6
- * then you can use all method on `ctx.helper` that is a instance of Helper.
7
- */
8
- export default class Helper extends BaseContextClass {
9
- /**
10
- * Generate URL path(without host) for route. Takes the route name and a map of named params.
11
- * @function Helper#pathFor
12
- * @param {String} name - Router Name
13
- * @param {Object} params - Other params
14
- *
15
- * @example
16
- * ```js
17
- * app.get('home', '/index.htm', 'home.index');
18
- * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
19
- * => /index.htm?by=recent&limit=20
20
- * ```
21
- * @return {String} url path(without host)
22
- */
23
- pathFor(name, params) {
24
- return this.app.router.url(name, params);
25
- }
26
- /**
27
- * Generate full URL(with host) for route. Takes the route name and a map of named params.
28
- * @function Helper#urlFor
29
- * @param {String} name - Router name
30
- * @param {Object} params - Other params
31
- * @example
32
- * ```js
33
- * app.get('home', '/index.htm', 'home.index');
34
- * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
35
- * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
36
- * ```
37
- * @return {String} full url(with host)
38
- */
39
- urlFor(name, params) {
40
- return this.ctx.protocol + '://' + this.ctx.host + url.resolve('/', this.pathFor(name, params));
41
- }
42
- }
43
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2FwcC9leHRlbmQvaGVscGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sR0FBRyxNQUFNLFVBQVUsQ0FBQztBQUMzQixPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxzQ0FBc0MsQ0FBQztBQUV4RTs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE9BQU8sT0FBTyxNQUFPLFNBQVEsZ0JBQWdCO0lBQ2xEOzs7Ozs7Ozs7Ozs7O09BYUc7SUFDSCxPQUFPLENBQUMsSUFBWSxFQUFFLE1BQTJCO1FBQy9DLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQztJQUMzQyxDQUFDO0lBRUQ7Ozs7Ozs7Ozs7OztPQVlHO0lBQ0gsTUFBTSxDQUFDLElBQVksRUFBRSxNQUEyQjtRQUM5QyxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUMsUUFBUSxHQUFHLEtBQUssR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksR0FBRyxHQUFHLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQ2xHLENBQUM7Q0FDRiJ9
@@ -1,141 +0,0 @@
1
- import { Request as EggCoreRequest } from '@eggjs/core';
2
- import type { Application } from '../../lib/application.js';
3
- import type Context from './context.js';
4
- import Response from './response.js';
5
- export default class Request extends EggCoreRequest {
6
- app: Application;
7
- ctx: Context;
8
- response: Response;
9
- /**
10
- * Request body, parsed from koa-bodyparser or @eggjs/multipart
11
- */
12
- body: any;
13
- /**
14
- * Parse the "Host" header field host
15
- * and support X-Forwarded-Host when a
16
- * proxy is enabled.
17
- * @member {String} Request#host
18
- * @example
19
- * ip + port
20
- * ```js
21
- * this.request.host
22
- * => '127.0.0.1:7001'
23
- * ```
24
- * or domain
25
- * ```js
26
- * this.request.host
27
- * => 'demo.eggjs.org'
28
- * ```
29
- */
30
- get host(): string;
31
- /**
32
- * @member {String} Request#protocol
33
- * @example
34
- * ```js
35
- * this.request.protocol
36
- * => 'https'
37
- * ```
38
- */
39
- get protocol(): string;
40
- /**
41
- * Get all pass through ip addresses from the request.
42
- * Enable only on `app.config.proxy = true`
43
- *
44
- * @member {Array} Request#ips
45
- * @example
46
- * ```js
47
- * this.request.ips
48
- * => ['100.23.1.2', '201.10.10.2']
49
- * ```
50
- */
51
- get ips(): string[];
52
- /**
53
- * Get the request remote IPv4 address
54
- * @member {String} Request#ip
55
- * @return {String} IPv4 address
56
- * @example
57
- * ```js
58
- * this.request.ip
59
- * => '127.0.0.1'
60
- * => '111.10.2.1'
61
- * ```
62
- */
63
- get ip(): string;
64
- /**
65
- * Set the request remote IPv4 address
66
- * @member {String} Request#ip
67
- * @param {String} ip - IPv4 address
68
- * @example
69
- * ```js
70
- * this.request.ip
71
- * => '127.0.0.1'
72
- * => '111.10.2.1'
73
- * ```
74
- */
75
- set ip(ip: string);
76
- /**
77
- * detect if response should be json
78
- * 1. url path ends with `.json`
79
- * 2. response type is set to json
80
- * 3. detect by request accept header
81
- *
82
- * @member {Boolean} Request#acceptJSON
83
- * @since 1.0.0
84
- */
85
- get acceptJSON(): boolean;
86
- _customQuery(cacheName: symbol, filter: (value: string | string[]) => string | string[]): Record<string, string | string[]>;
87
- /**
88
- * get params pass by querystring, all values are of string type.
89
- * @member {Object} Request#query
90
- * @example
91
- * ```js
92
- * GET http://127.0.0.1:7001?name=Foo&age=20&age=21
93
- * this.query
94
- * => { 'name': 'Foo', 'age': '20' }
95
- *
96
- * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
97
- * this.query
98
- * =>
99
- * {
100
- * "a": "b",
101
- * "o[foo]": "bar",
102
- * "b[]": "1",
103
- * "e": "val"
104
- * }
105
- * ```
106
- */
107
- get query(): Record<string, string>;
108
- /**
109
- * get params pass by querystring, all value are Array type. {@link Request#query}
110
- * @member {Array} Request#queries
111
- * @example
112
- * ```js
113
- * GET http://127.0.0.1:7001?a=b&a=c&o[foo]=bar&b[]=1&b[]=2&e=val
114
- * this.queries
115
- * =>
116
- * {
117
- * "a": ["b", "c"],
118
- * "o[foo]": ["bar"],
119
- * "b[]": ["1", "2"],
120
- * "e": ["val"]
121
- * }
122
- * ```
123
- */
124
- get queries(): Record<string, string[]>;
125
- /**
126
- * Set query-string as an object.
127
- *
128
- * @function Request#query
129
- * @param {Object} obj set querystring and query object for request.
130
- */
131
- set query(obj: Record<string, string>);
132
- }
133
- declare module '@eggjs/core' {
134
- interface Request {
135
- body: any;
136
- get acceptJSON(): boolean;
137
- get query(): Record<string, string>;
138
- set query(obj: Record<string, string>);
139
- get queries(): Record<string, string[]>;
140
- }
141
- }