@aligent/cdk-prerender-proxy 0.2.7 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (210) hide show
  1. package/index.js +1 -1
  2. package/index.ts +29 -0
  3. package/lib/error-response-construct.ts +54 -0
  4. package/lib/handlers/cache-control.ts +1 -4
  5. package/lib/handlers/error-response.ts +0 -1
  6. package/lib/handlers/prerender.ts +2 -3
  7. package/lib/prerender-cf-cache-control-construct.ts +58 -0
  8. package/lib/prerender-check-construct.ts +43 -0
  9. package/lib/prerender-construct.ts +55 -0
  10. package/lib/prerender-lambda-construct.ts +48 -0
  11. package/package.json +17 -26
  12. package/index.d.ts +0 -6
  13. package/lib/error-response-construct.d.ts +0 -9
  14. package/lib/error-response-construct.js +0 -32
  15. package/lib/handlers/node_modules/.package-lock.json +0 -55
  16. package/lib/handlers/node_modules/@types/aws-lambda/LICENSE +0 -21
  17. package/lib/handlers/node_modules/@types/aws-lambda/README.md +0 -16
  18. package/lib/handlers/node_modules/@types/aws-lambda/common/api-gateway.d.ts +0 -79
  19. package/lib/handlers/node_modules/@types/aws-lambda/common/cloudfront.d.ts +0 -79
  20. package/lib/handlers/node_modules/@types/aws-lambda/handler.d.ts +0 -171
  21. package/lib/handlers/node_modules/@types/aws-lambda/index.d.ts +0 -85
  22. package/lib/handlers/node_modules/@types/aws-lambda/package.json +0 -210
  23. package/lib/handlers/node_modules/@types/aws-lambda/trigger/alb.d.ts +0 -48
  24. package/lib/handlers/node_modules/@types/aws-lambda/trigger/api-gateway-authorizer.d.ts +0 -174
  25. package/lib/handlers/node_modules/@types/aws-lambda/trigger/api-gateway-proxy.d.ts +0 -187
  26. package/lib/handlers/node_modules/@types/aws-lambda/trigger/appsync-resolver.d.ts +0 -51
  27. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cloudformation-custom-resource.d.ts +0 -68
  28. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cloudfront-request.d.ts +0 -20
  29. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cloudfront-response.d.ts +0 -21
  30. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cloudwatch-events.d.ts +0 -8
  31. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cloudwatch-logs.d.ts +0 -37
  32. package/lib/handlers/node_modules/@types/aws-lambda/trigger/codebuild-cloudwatch-state.d.ts +0 -104
  33. package/lib/handlers/node_modules/@types/aws-lambda/trigger/codepipeline-cloudwatch-action.d.ts +0 -31
  34. package/lib/handlers/node_modules/@types/aws-lambda/trigger/codepipeline-cloudwatch-pipeline.d.ts +0 -32
  35. package/lib/handlers/node_modules/@types/aws-lambda/trigger/codepipeline-cloudwatch-stage.d.ts +0 -23
  36. package/lib/handlers/node_modules/@types/aws-lambda/trigger/codepipeline-cloudwatch.d.ts +0 -11
  37. package/lib/handlers/node_modules/@types/aws-lambda/trigger/codepipeline.d.ts +0 -55
  38. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/_common.d.ts +0 -41
  39. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/create-auth-challenge.d.ts +0 -22
  40. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/custom-email-sender.d.ts +0 -86
  41. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/custom-message.d.ts +0 -44
  42. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/define-auth-challenge.d.ts +0 -21
  43. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/index.d.ts +0 -119
  44. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/post-authentication.d.ts +0 -15
  45. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/post-confirmation.d.ts +0 -22
  46. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/pre-authentication.d.ts +0 -15
  47. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/pre-signup.d.ts +0 -31
  48. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/pre-token-generation.d.ts +0 -45
  49. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/user-migration.d.ts +0 -39
  50. package/lib/handlers/node_modules/@types/aws-lambda/trigger/cognito-user-pool-trigger/verify-auth-challenge-response.d.ts +0 -20
  51. package/lib/handlers/node_modules/@types/aws-lambda/trigger/connect-contact-flow.d.ts +0 -65
  52. package/lib/handlers/node_modules/@types/aws-lambda/trigger/dynamodb-stream.d.ts +0 -45
  53. package/lib/handlers/node_modules/@types/aws-lambda/trigger/eventbridge.d.ts +0 -18
  54. package/lib/handlers/node_modules/@types/aws-lambda/trigger/iot.d.ts +0 -28
  55. package/lib/handlers/node_modules/@types/aws-lambda/trigger/kinesis-firehose-transformation.d.ts +0 -45
  56. package/lib/handlers/node_modules/@types/aws-lambda/trigger/kinesis-stream.d.ts +0 -28
  57. package/lib/handlers/node_modules/@types/aws-lambda/trigger/lex.d.ts +0 -116
  58. package/lib/handlers/node_modules/@types/aws-lambda/trigger/msk.d.ts +0 -21
  59. package/lib/handlers/node_modules/@types/aws-lambda/trigger/s3-batch.d.ts +0 -41
  60. package/lib/handlers/node_modules/@types/aws-lambda/trigger/s3.d.ts +0 -60
  61. package/lib/handlers/node_modules/@types/aws-lambda/trigger/ses.d.ts +0 -103
  62. package/lib/handlers/node_modules/@types/aws-lambda/trigger/sns.d.ts +0 -38
  63. package/lib/handlers/node_modules/@types/aws-lambda/trigger/sqs.d.ts +0 -46
  64. package/lib/handlers/node_modules/@types/node/LICENSE +0 -21
  65. package/lib/handlers/node_modules/@types/node/README.md +0 -16
  66. package/lib/handlers/node_modules/@types/node/assert/strict.d.ts +0 -4
  67. package/lib/handlers/node_modules/@types/node/assert.d.ts +0 -124
  68. package/lib/handlers/node_modules/@types/node/async_hooks.d.ts +0 -226
  69. package/lib/handlers/node_modules/@types/node/base.d.ts +0 -19
  70. package/lib/handlers/node_modules/@types/node/buffer.d.ts +0 -84
  71. package/lib/handlers/node_modules/@types/node/child_process.d.ts +0 -526
  72. package/lib/handlers/node_modules/@types/node/cluster.d.ts +0 -262
  73. package/lib/handlers/node_modules/@types/node/console.d.ts +0 -133
  74. package/lib/handlers/node_modules/@types/node/constants.d.ts +0 -13
  75. package/lib/handlers/node_modules/@types/node/crypto.d.ts +0 -1580
  76. package/lib/handlers/node_modules/@types/node/dgram.d.ts +0 -141
  77. package/lib/handlers/node_modules/@types/node/diagnostic_channel.d.ts +0 -34
  78. package/lib/handlers/node_modules/@types/node/dns/promises.d.ts +0 -97
  79. package/lib/handlers/node_modules/@types/node/dns.d.ts +0 -322
  80. package/lib/handlers/node_modules/@types/node/domain.d.ts +0 -24
  81. package/lib/handlers/node_modules/@types/node/events.d.ts +0 -93
  82. package/lib/handlers/node_modules/@types/node/fs/promises.d.ts +0 -592
  83. package/lib/handlers/node_modules/@types/node/fs.d.ts +0 -2239
  84. package/lib/handlers/node_modules/@types/node/globals.d.ts +0 -655
  85. package/lib/handlers/node_modules/@types/node/globals.global.d.ts +0 -1
  86. package/lib/handlers/node_modules/@types/node/http.d.ts +0 -434
  87. package/lib/handlers/node_modules/@types/node/http2.d.ts +0 -976
  88. package/lib/handlers/node_modules/@types/node/https.d.ts +0 -36
  89. package/lib/handlers/node_modules/@types/node/index.d.ts +0 -58
  90. package/lib/handlers/node_modules/@types/node/inspector.d.ts +0 -3041
  91. package/lib/handlers/node_modules/@types/node/module.d.ts +0 -52
  92. package/lib/handlers/node_modules/@types/node/net.d.ts +0 -326
  93. package/lib/handlers/node_modules/@types/node/os.d.ts +0 -239
  94. package/lib/handlers/node_modules/@types/node/package.json +0 -232
  95. package/lib/handlers/node_modules/@types/node/path.d.ts +0 -163
  96. package/lib/handlers/node_modules/@types/node/perf_hooks.d.ts +0 -310
  97. package/lib/handlers/node_modules/@types/node/process.d.ts +0 -461
  98. package/lib/handlers/node_modules/@types/node/punycode.d.ts +0 -75
  99. package/lib/handlers/node_modules/@types/node/querystring.d.ts +0 -28
  100. package/lib/handlers/node_modules/@types/node/readline.d.ts +0 -192
  101. package/lib/handlers/node_modules/@types/node/repl.d.ts +0 -395
  102. package/lib/handlers/node_modules/@types/node/stream/promises.d.ts +0 -67
  103. package/lib/handlers/node_modules/@types/node/stream.d.ts +0 -471
  104. package/lib/handlers/node_modules/@types/node/string_decoder.d.ts +0 -7
  105. package/lib/handlers/node_modules/@types/node/timers/promises.d.ts +0 -21
  106. package/lib/handlers/node_modules/@types/node/timers.d.ts +0 -27
  107. package/lib/handlers/node_modules/@types/node/tls.d.ts +0 -793
  108. package/lib/handlers/node_modules/@types/node/trace_events.d.ts +0 -61
  109. package/lib/handlers/node_modules/@types/node/ts3.6/assert.d.ts +0 -98
  110. package/lib/handlers/node_modules/@types/node/ts3.6/base.d.ts +0 -68
  111. package/lib/handlers/node_modules/@types/node/ts3.6/index.d.ts +0 -7
  112. package/lib/handlers/node_modules/@types/node/tty.d.ts +0 -66
  113. package/lib/handlers/node_modules/@types/node/url.d.ts +0 -116
  114. package/lib/handlers/node_modules/@types/node/util/types.d.ts +0 -53
  115. package/lib/handlers/node_modules/@types/node/util.d.ts +0 -156
  116. package/lib/handlers/node_modules/@types/node/v8.d.ts +0 -198
  117. package/lib/handlers/node_modules/@types/node/vm.d.ts +0 -152
  118. package/lib/handlers/node_modules/@types/node/wasi.d.ts +0 -86
  119. package/lib/handlers/node_modules/@types/node/worker_threads.d.ts +0 -282
  120. package/lib/handlers/node_modules/@types/node/zlib.d.ts +0 -361
  121. package/lib/handlers/node_modules/axios/CHANGELOG.md +0 -685
  122. package/lib/handlers/node_modules/axios/LICENSE +0 -19
  123. package/lib/handlers/node_modules/axios/README.md +0 -800
  124. package/lib/handlers/node_modules/axios/UPGRADE_GUIDE.md +0 -162
  125. package/lib/handlers/node_modules/axios/dist/axios.js +0 -1756
  126. package/lib/handlers/node_modules/axios/dist/axios.map +0 -1
  127. package/lib/handlers/node_modules/axios/dist/axios.min.js +0 -3
  128. package/lib/handlers/node_modules/axios/dist/axios.min.map +0 -1
  129. package/lib/handlers/node_modules/axios/index.d.ts +0 -161
  130. package/lib/handlers/node_modules/axios/index.js +0 -1
  131. package/lib/handlers/node_modules/axios/lib/adapters/README.md +0 -37
  132. package/lib/handlers/node_modules/axios/lib/adapters/http.js +0 -303
  133. package/lib/handlers/node_modules/axios/lib/adapters/xhr.js +0 -179
  134. package/lib/handlers/node_modules/axios/lib/axios.js +0 -56
  135. package/lib/handlers/node_modules/axios/lib/cancel/Cancel.js +0 -19
  136. package/lib/handlers/node_modules/axios/lib/cancel/CancelToken.js +0 -57
  137. package/lib/handlers/node_modules/axios/lib/cancel/isCancel.js +0 -5
  138. package/lib/handlers/node_modules/axios/lib/core/Axios.js +0 -95
  139. package/lib/handlers/node_modules/axios/lib/core/InterceptorManager.js +0 -52
  140. package/lib/handlers/node_modules/axios/lib/core/README.md +0 -7
  141. package/lib/handlers/node_modules/axios/lib/core/buildFullPath.js +0 -20
  142. package/lib/handlers/node_modules/axios/lib/core/createError.js +0 -18
  143. package/lib/handlers/node_modules/axios/lib/core/dispatchRequest.js +0 -79
  144. package/lib/handlers/node_modules/axios/lib/core/enhanceError.js +0 -42
  145. package/lib/handlers/node_modules/axios/lib/core/mergeConfig.js +0 -87
  146. package/lib/handlers/node_modules/axios/lib/core/settle.js +0 -25
  147. package/lib/handlers/node_modules/axios/lib/core/transformData.js +0 -20
  148. package/lib/handlers/node_modules/axios/lib/defaults.js +0 -98
  149. package/lib/handlers/node_modules/axios/lib/helpers/README.md +0 -7
  150. package/lib/handlers/node_modules/axios/lib/helpers/bind.js +0 -11
  151. package/lib/handlers/node_modules/axios/lib/helpers/buildURL.js +0 -70
  152. package/lib/handlers/node_modules/axios/lib/helpers/combineURLs.js +0 -14
  153. package/lib/handlers/node_modules/axios/lib/helpers/cookies.js +0 -53
  154. package/lib/handlers/node_modules/axios/lib/helpers/deprecatedMethod.js +0 -24
  155. package/lib/handlers/node_modules/axios/lib/helpers/isAbsoluteURL.js +0 -14
  156. package/lib/handlers/node_modules/axios/lib/helpers/isAxiosError.js +0 -11
  157. package/lib/handlers/node_modules/axios/lib/helpers/isURLSameOrigin.js +0 -68
  158. package/lib/handlers/node_modules/axios/lib/helpers/normalizeHeaderName.js +0 -12
  159. package/lib/handlers/node_modules/axios/lib/helpers/parseHeaders.js +0 -53
  160. package/lib/handlers/node_modules/axios/lib/helpers/spread.js +0 -27
  161. package/lib/handlers/node_modules/axios/lib/utils.js +0 -351
  162. package/lib/handlers/node_modules/axios/package.json +0 -86
  163. package/lib/handlers/node_modules/buffer-from/LICENSE +0 -21
  164. package/lib/handlers/node_modules/buffer-from/index.js +0 -69
  165. package/lib/handlers/node_modules/buffer-from/package.json +0 -19
  166. package/lib/handlers/node_modules/buffer-from/readme.md +0 -69
  167. package/lib/handlers/node_modules/follow-redirects/LICENSE +0 -18
  168. package/lib/handlers/node_modules/follow-redirects/README.md +0 -148
  169. package/lib/handlers/node_modules/follow-redirects/debug.js +0 -14
  170. package/lib/handlers/node_modules/follow-redirects/http.js +0 -1
  171. package/lib/handlers/node_modules/follow-redirects/https.js +0 -1
  172. package/lib/handlers/node_modules/follow-redirects/index.js +0 -531
  173. package/lib/handlers/node_modules/follow-redirects/package.json +0 -59
  174. package/lib/handlers/node_modules/source-map/CHANGELOG.md +0 -301
  175. package/lib/handlers/node_modules/source-map/LICENSE +0 -28
  176. package/lib/handlers/node_modules/source-map/README.md +0 -742
  177. package/lib/handlers/node_modules/source-map/dist/source-map.debug.js +0 -3234
  178. package/lib/handlers/node_modules/source-map/dist/source-map.js +0 -3233
  179. package/lib/handlers/node_modules/source-map/dist/source-map.min.js +0 -2
  180. package/lib/handlers/node_modules/source-map/dist/source-map.min.js.map +0 -1
  181. package/lib/handlers/node_modules/source-map/lib/array-set.js +0 -121
  182. package/lib/handlers/node_modules/source-map/lib/base64-vlq.js +0 -140
  183. package/lib/handlers/node_modules/source-map/lib/base64.js +0 -67
  184. package/lib/handlers/node_modules/source-map/lib/binary-search.js +0 -111
  185. package/lib/handlers/node_modules/source-map/lib/mapping-list.js +0 -79
  186. package/lib/handlers/node_modules/source-map/lib/quick-sort.js +0 -114
  187. package/lib/handlers/node_modules/source-map/lib/source-map-consumer.js +0 -1145
  188. package/lib/handlers/node_modules/source-map/lib/source-map-generator.js +0 -425
  189. package/lib/handlers/node_modules/source-map/lib/source-node.js +0 -413
  190. package/lib/handlers/node_modules/source-map/lib/util.js +0 -488
  191. package/lib/handlers/node_modules/source-map/package.json +0 -73
  192. package/lib/handlers/node_modules/source-map/source-map.d.ts +0 -98
  193. package/lib/handlers/node_modules/source-map/source-map.js +0 -8
  194. package/lib/handlers/node_modules/source-map-support/LICENSE.md +0 -21
  195. package/lib/handlers/node_modules/source-map-support/README.md +0 -284
  196. package/lib/handlers/node_modules/source-map-support/browser-source-map-support.js +0 -114
  197. package/lib/handlers/node_modules/source-map-support/package.json +0 -31
  198. package/lib/handlers/node_modules/source-map-support/register.js +0 -1
  199. package/lib/handlers/node_modules/source-map-support/source-map-support.js +0 -604
  200. package/lib/handlers/package-lock.json +0 -108
  201. package/lib/handlers/package.json +0 -13
  202. package/lib/handlers/tsconfig.json +0 -22
  203. package/lib/prerender-cf-cache-control-construct.d.ts +0 -10
  204. package/lib/prerender-cf-cache-control-construct.js +0 -33
  205. package/lib/prerender-check-construct.d.ts +0 -6
  206. package/lib/prerender-check-construct.js +0 -25
  207. package/lib/prerender-construct.d.ts +0 -11
  208. package/lib/prerender-construct.js +0 -34
  209. package/lib/prerender-lambda-construct.d.ts +0 -17
  210. package/lib/prerender-lambda-construct.js +0 -19
@@ -1,526 +0,0 @@
1
- declare module 'child_process' {
2
- import { BaseEncodingOptions } from 'fs';
3
- import { EventEmitter, Abortable } from 'events';
4
- import * as net from 'net';
5
- import { Writable, Readable, Stream, Pipe } from 'stream';
6
-
7
- type Serializable = string | object | number | boolean | bigint;
8
- type SendHandle = net.Socket | net.Server;
9
-
10
- interface ChildProcess extends EventEmitter {
11
- stdin: Writable | null;
12
- stdout: Readable | null;
13
- stderr: Readable | null;
14
- readonly channel?: Pipe | null;
15
- readonly stdio: [
16
- Writable | null, // stdin
17
- Readable | null, // stdout
18
- Readable | null, // stderr
19
- Readable | Writable | null | undefined, // extra
20
- Readable | Writable | null | undefined // extra
21
- ];
22
- readonly killed: boolean;
23
- readonly pid?: number;
24
- readonly connected: boolean;
25
- readonly exitCode: number | null;
26
- readonly signalCode: NodeJS.Signals | null;
27
- readonly spawnargs: string[];
28
- readonly spawnfile: string;
29
- kill(signal?: NodeJS.Signals | number): boolean;
30
- send(message: Serializable, callback?: (error: Error | null) => void): boolean;
31
- send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean;
32
- send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void): boolean;
33
- disconnect(): void;
34
- unref(): void;
35
- ref(): void;
36
-
37
- /**
38
- * events.EventEmitter
39
- * 1. close
40
- * 2. disconnect
41
- * 3. error
42
- * 4. exit
43
- * 5. message
44
- * 6. spawn
45
- */
46
-
47
- addListener(event: string, listener: (...args: any[]) => void): this;
48
- addListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
49
- addListener(event: "disconnect", listener: () => void): this;
50
- addListener(event: "error", listener: (err: Error) => void): this;
51
- addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
52
- addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
53
- addListener(event: "spawn", listener: () => void): this;
54
-
55
- emit(event: string | symbol, ...args: any[]): boolean;
56
- emit(event: "close", code: number | null, signal: NodeJS.Signals | null): boolean;
57
- emit(event: "disconnect"): boolean;
58
- emit(event: "error", err: Error): boolean;
59
- emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean;
60
- emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean;
61
- emit(event: "spawn", listener: () => void): boolean;
62
-
63
- on(event: string, listener: (...args: any[]) => void): this;
64
- on(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
65
- on(event: "disconnect", listener: () => void): this;
66
- on(event: "error", listener: (err: Error) => void): this;
67
- on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
68
- on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
69
- on(event: "spawn", listener: () => void): this;
70
-
71
- once(event: string, listener: (...args: any[]) => void): this;
72
- once(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
73
- once(event: "disconnect", listener: () => void): this;
74
- once(event: "error", listener: (err: Error) => void): this;
75
- once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
76
- once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
77
- once(event: "spawn", listener: () => void): this;
78
-
79
- prependListener(event: string, listener: (...args: any[]) => void): this;
80
- prependListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
81
- prependListener(event: "disconnect", listener: () => void): this;
82
- prependListener(event: "error", listener: (err: Error) => void): this;
83
- prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
84
- prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
85
- prependListener(event: "spawn", listener: () => void): this;
86
-
87
- prependOnceListener(event: string, listener: (...args: any[]) => void): this;
88
- prependOnceListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
89
- prependOnceListener(event: "disconnect", listener: () => void): this;
90
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
91
- prependOnceListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this;
92
- prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this;
93
- prependOnceListener(event: "spawn", listener: () => void): this;
94
- }
95
-
96
- // return this object when stdio option is undefined or not specified
97
- interface ChildProcessWithoutNullStreams extends ChildProcess {
98
- stdin: Writable;
99
- stdout: Readable;
100
- stderr: Readable;
101
- readonly stdio: [
102
- Writable, // stdin
103
- Readable, // stdout
104
- Readable, // stderr
105
- Readable | Writable | null | undefined, // extra, no modification
106
- Readable | Writable | null | undefined // extra, no modification
107
- ];
108
- }
109
-
110
- // return this object when stdio option is a tuple of 3
111
- interface ChildProcessByStdio<
112
- I extends null | Writable,
113
- O extends null | Readable,
114
- E extends null | Readable,
115
- > extends ChildProcess {
116
- stdin: I;
117
- stdout: O;
118
- stderr: E;
119
- readonly stdio: [
120
- I,
121
- O,
122
- E,
123
- Readable | Writable | null | undefined, // extra, no modification
124
- Readable | Writable | null | undefined // extra, no modification
125
- ];
126
- }
127
-
128
- interface MessageOptions {
129
- keepOpen?: boolean;
130
- }
131
-
132
- type IOType = "overlapped" | "pipe" | "ignore" | "inherit";
133
-
134
- type StdioOptions = IOType | Array<(IOType | "ipc" | Stream | number | null | undefined)>;
135
-
136
- type SerializationType = 'json' | 'advanced';
137
-
138
- interface MessagingOptions extends Abortable {
139
- /**
140
- * Specify the kind of serialization used for sending messages between processes.
141
- * @default 'json'
142
- */
143
- serialization?: SerializationType;
144
-
145
- /**
146
- * The signal value to be used when the spawned process will be killed by the abort signal.
147
- * @default 'SIGTERM'
148
- */
149
- killSignal?: NodeJS.Signals | number;
150
- }
151
-
152
- interface ProcessEnvOptions {
153
- uid?: number;
154
- gid?: number;
155
- cwd?: string;
156
- env?: NodeJS.ProcessEnv;
157
- }
158
-
159
- interface CommonOptions extends ProcessEnvOptions {
160
- /**
161
- * @default true
162
- */
163
- windowsHide?: boolean;
164
- /**
165
- * @default 0
166
- */
167
- timeout?: number;
168
- }
169
-
170
- interface CommonSpawnOptions extends CommonOptions, MessagingOptions, Abortable {
171
- argv0?: string;
172
- stdio?: StdioOptions;
173
- shell?: boolean | string;
174
- windowsVerbatimArguments?: boolean;
175
- }
176
-
177
- interface SpawnOptions extends CommonSpawnOptions {
178
- detached?: boolean;
179
- }
180
-
181
- interface SpawnOptionsWithoutStdio extends SpawnOptions {
182
- stdio?: StdioPipeNamed | StdioPipe[];
183
- }
184
-
185
- type StdioNull = 'inherit' | 'ignore' | Stream;
186
- type StdioPipeNamed = 'pipe' | 'overlapped';
187
- type StdioPipe = undefined | null | StdioPipeNamed;
188
-
189
- interface SpawnOptionsWithStdioTuple<
190
- Stdin extends StdioNull | StdioPipe,
191
- Stdout extends StdioNull | StdioPipe,
192
- Stderr extends StdioNull | StdioPipe,
193
- > extends SpawnOptions {
194
- stdio: [Stdin, Stdout, Stderr];
195
- }
196
-
197
- // overloads of spawn without 'args'
198
- function spawn(command: string, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams;
199
-
200
- function spawn(
201
- command: string,
202
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>,
203
- ): ChildProcessByStdio<Writable, Readable, Readable>;
204
- function spawn(
205
- command: string,
206
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>,
207
- ): ChildProcessByStdio<Writable, Readable, null>;
208
- function spawn(
209
- command: string,
210
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>,
211
- ): ChildProcessByStdio<Writable, null, Readable>;
212
- function spawn(
213
- command: string,
214
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>,
215
- ): ChildProcessByStdio<null, Readable, Readable>;
216
- function spawn(
217
- command: string,
218
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>,
219
- ): ChildProcessByStdio<Writable, null, null>;
220
- function spawn(
221
- command: string,
222
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>,
223
- ): ChildProcessByStdio<null, Readable, null>;
224
- function spawn(
225
- command: string,
226
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>,
227
- ): ChildProcessByStdio<null, null, Readable>;
228
- function spawn(
229
- command: string,
230
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>,
231
- ): ChildProcessByStdio<null, null, null>;
232
-
233
- function spawn(command: string, options: SpawnOptions): ChildProcess;
234
-
235
- // overloads of spawn with 'args'
236
- function spawn(command: string, args?: ReadonlyArray<string>, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams;
237
-
238
- function spawn(
239
- command: string,
240
- args: ReadonlyArray<string>,
241
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>,
242
- ): ChildProcessByStdio<Writable, Readable, Readable>;
243
- function spawn(
244
- command: string,
245
- args: ReadonlyArray<string>,
246
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>,
247
- ): ChildProcessByStdio<Writable, Readable, null>;
248
- function spawn(
249
- command: string,
250
- args: ReadonlyArray<string>,
251
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>,
252
- ): ChildProcessByStdio<Writable, null, Readable>;
253
- function spawn(
254
- command: string,
255
- args: ReadonlyArray<string>,
256
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>,
257
- ): ChildProcessByStdio<null, Readable, Readable>;
258
- function spawn(
259
- command: string,
260
- args: ReadonlyArray<string>,
261
- options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>,
262
- ): ChildProcessByStdio<Writable, null, null>;
263
- function spawn(
264
- command: string,
265
- args: ReadonlyArray<string>,
266
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>,
267
- ): ChildProcessByStdio<null, Readable, null>;
268
- function spawn(
269
- command: string,
270
- args: ReadonlyArray<string>,
271
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>,
272
- ): ChildProcessByStdio<null, null, Readable>;
273
- function spawn(
274
- command: string,
275
- args: ReadonlyArray<string>,
276
- options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>,
277
- ): ChildProcessByStdio<null, null, null>;
278
-
279
- function spawn(command: string, args: ReadonlyArray<string>, options: SpawnOptions): ChildProcess;
280
-
281
- interface ExecOptions extends CommonOptions {
282
- shell?: string;
283
- maxBuffer?: number;
284
- killSignal?: NodeJS.Signals | number;
285
- }
286
-
287
- interface ExecOptionsWithStringEncoding extends ExecOptions {
288
- encoding: BufferEncoding;
289
- }
290
-
291
- interface ExecOptionsWithBufferEncoding extends ExecOptions {
292
- encoding: BufferEncoding | null; // specify `null`.
293
- }
294
-
295
- interface ExecException extends Error {
296
- cmd?: string;
297
- killed?: boolean;
298
- code?: number;
299
- signal?: NodeJS.Signals;
300
- }
301
-
302
- // no `options` definitely means stdout/stderr are `string`.
303
- function exec(command: string, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess;
304
-
305
- // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
306
- function exec(command: string, options: { encoding: "buffer" | null } & ExecOptions, callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
307
-
308
- // `options` with well known `encoding` means stdout/stderr are definitely `string`.
309
- function exec(command: string, options: { encoding: BufferEncoding } & ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess;
310
-
311
- // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
312
- // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
313
- function exec(
314
- command: string,
315
- options: { encoding: BufferEncoding } & ExecOptions,
316
- callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
317
- ): ChildProcess;
318
-
319
- // `options` without an `encoding` means stdout/stderr are definitely `string`.
320
- function exec(command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess;
321
-
322
- // fallback if nothing else matches. Worst case is always `string | Buffer`.
323
- function exec(
324
- command: string,
325
- options: (BaseEncodingOptions & ExecOptions) | undefined | null,
326
- callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
327
- ): ChildProcess;
328
-
329
- interface PromiseWithChild<T> extends Promise<T> {
330
- child: ChildProcess;
331
- }
332
-
333
- // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime.
334
- namespace exec {
335
- function __promisify__(command: string): PromiseWithChild<{ stdout: string, stderr: string }>;
336
- function __promisify__(command: string, options: { encoding: "buffer" | null } & ExecOptions): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>;
337
- function __promisify__(command: string, options: { encoding: BufferEncoding } & ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
338
- function __promisify__(command: string, options: ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
339
- function __promisify__(command: string, options?: (BaseEncodingOptions & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
340
- }
341
-
342
- interface ExecFileOptions extends CommonOptions, Abortable {
343
- maxBuffer?: number;
344
- killSignal?: NodeJS.Signals | number;
345
- windowsVerbatimArguments?: boolean;
346
- shell?: boolean | string;
347
- signal?: AbortSignal;
348
- }
349
- interface ExecFileOptionsWithStringEncoding extends ExecFileOptions {
350
- encoding: BufferEncoding;
351
- }
352
- interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions {
353
- encoding: 'buffer' | null;
354
- }
355
- interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions {
356
- encoding: BufferEncoding;
357
- }
358
- type ExecFileException = ExecException & NodeJS.ErrnoException;
359
-
360
- function execFile(file: string): ChildProcess;
361
- function execFile(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess;
362
- function execFile(file: string, args?: ReadonlyArray<string> | null): ChildProcess;
363
- function execFile(file: string, args: ReadonlyArray<string> | undefined | null, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess;
364
-
365
- // no `options` definitely means stdout/stderr are `string`.
366
- function execFile(file: string, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
367
- function execFile(file: string, args: ReadonlyArray<string> | undefined | null, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
368
-
369
- // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`.
370
- function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
371
- function execFile(
372
- file: string,
373
- args: ReadonlyArray<string> | undefined | null,
374
- options: ExecFileOptionsWithBufferEncoding,
375
- callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void,
376
- ): ChildProcess;
377
-
378
- // `options` with well known `encoding` means stdout/stderr are definitely `string`.
379
- function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
380
- function execFile(
381
- file: string,
382
- args: ReadonlyArray<string> | undefined | null,
383
- options: ExecFileOptionsWithStringEncoding,
384
- callback: (error: ExecFileException | null, stdout: string, stderr: string) => void,
385
- ): ChildProcess;
386
-
387
- // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`.
388
- // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`.
389
- function execFile(
390
- file: string,
391
- options: ExecFileOptionsWithOtherEncoding,
392
- callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
393
- ): ChildProcess;
394
- function execFile(
395
- file: string,
396
- args: ReadonlyArray<string> | undefined | null,
397
- options: ExecFileOptionsWithOtherEncoding,
398
- callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void,
399
- ): ChildProcess;
400
-
401
- // `options` without an `encoding` means stdout/stderr are definitely `string`.
402
- function execFile(file: string, options: ExecFileOptions, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void): ChildProcess;
403
- function execFile(
404
- file: string,
405
- args: ReadonlyArray<string> | undefined | null,
406
- options: ExecFileOptions,
407
- callback: (error: ExecFileException | null, stdout: string, stderr: string) => void
408
- ): ChildProcess;
409
-
410
- // fallback if nothing else matches. Worst case is always `string | Buffer`.
411
- function execFile(
412
- file: string,
413
- options: (BaseEncodingOptions & ExecFileOptions) | undefined | null,
414
- callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null,
415
- ): ChildProcess;
416
- function execFile(
417
- file: string,
418
- args: ReadonlyArray<string> | undefined | null,
419
- options: (BaseEncodingOptions & ExecFileOptions) | undefined | null,
420
- callback: ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null,
421
- ): ChildProcess;
422
-
423
- // NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime.
424
- namespace execFile {
425
- function __promisify__(file: string): PromiseWithChild<{ stdout: string, stderr: string }>;
426
- function __promisify__(file: string, args: ReadonlyArray<string> | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>;
427
- function __promisify__(file: string, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>;
428
- function __promisify__(file: string, args: ReadonlyArray<string> | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>;
429
- function __promisify__(file: string, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>;
430
- function __promisify__(file: string, args: ReadonlyArray<string> | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>;
431
- function __promisify__(file: string, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
432
- function __promisify__(
433
- file: string,
434
- args: ReadonlyArray<string> | undefined | null,
435
- options: ExecFileOptionsWithOtherEncoding,
436
- ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
437
- function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
438
- function __promisify__(file: string, args: ReadonlyArray<string> | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>;
439
- function __promisify__(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
440
- function __promisify__(
441
- file: string,
442
- args: ReadonlyArray<string> | undefined | null,
443
- options: (BaseEncodingOptions & ExecFileOptions) | undefined | null,
444
- ): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>;
445
- }
446
-
447
- interface ForkOptions extends ProcessEnvOptions, MessagingOptions, Abortable {
448
- execPath?: string;
449
- execArgv?: string[];
450
- silent?: boolean;
451
- stdio?: StdioOptions;
452
- detached?: boolean;
453
- windowsVerbatimArguments?: boolean;
454
- }
455
- function fork(modulePath: string, options?: ForkOptions): ChildProcess;
456
- function fork(modulePath: string, args?: ReadonlyArray<string>, options?: ForkOptions): ChildProcess;
457
-
458
- interface SpawnSyncOptions extends CommonSpawnOptions {
459
- input?: string | NodeJS.ArrayBufferView;
460
- maxBuffer?: number;
461
- encoding?: BufferEncoding | 'buffer' | null;
462
- }
463
- interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions {
464
- encoding: BufferEncoding;
465
- }
466
- interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions {
467
- encoding?: 'buffer' | null;
468
- }
469
- interface SpawnSyncReturns<T> {
470
- pid: number;
471
- output: string[];
472
- stdout: T;
473
- stderr: T;
474
- status: number | null;
475
- signal: NodeJS.Signals | null;
476
- error?: Error;
477
- }
478
- function spawnSync(command: string): SpawnSyncReturns<Buffer>;
479
- function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>;
480
- function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>;
481
- function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns<Buffer>;
482
- function spawnSync(command: string, args?: ReadonlyArray<string>, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>;
483
- function spawnSync(command: string, args?: ReadonlyArray<string>, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>;
484
- function spawnSync(command: string, args?: ReadonlyArray<string>, options?: SpawnSyncOptions): SpawnSyncReturns<Buffer>;
485
-
486
- interface ExecSyncOptions extends CommonOptions {
487
- input?: string | Uint8Array;
488
- stdio?: StdioOptions;
489
- shell?: string;
490
- killSignal?: NodeJS.Signals | number;
491
- maxBuffer?: number;
492
- encoding?: BufferEncoding | 'buffer' | null;
493
- }
494
- interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions {
495
- encoding: BufferEncoding;
496
- }
497
- interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions {
498
- encoding?: 'buffer' | null;
499
- }
500
- function execSync(command: string): Buffer;
501
- function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string;
502
- function execSync(command: string, options?: ExecSyncOptionsWithBufferEncoding): Buffer;
503
- function execSync(command: string, options?: ExecSyncOptions): Buffer;
504
-
505
- interface ExecFileSyncOptions extends CommonOptions {
506
- input?: string | NodeJS.ArrayBufferView;
507
- stdio?: StdioOptions;
508
- killSignal?: NodeJS.Signals | number;
509
- maxBuffer?: number;
510
- encoding?: BufferEncoding;
511
- shell?: boolean | string;
512
- }
513
- interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions {
514
- encoding: BufferEncoding;
515
- }
516
- interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions {
517
- encoding: BufferEncoding; // specify `null`.
518
- }
519
- function execFileSync(command: string): Buffer;
520
- function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string;
521
- function execFileSync(command: string, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer;
522
- function execFileSync(command: string, options?: ExecFileSyncOptions): Buffer;
523
- function execFileSync(command: string, args?: ReadonlyArray<string>, options?: ExecFileSyncOptionsWithStringEncoding): string;
524
- function execFileSync(command: string, args?: ReadonlyArray<string>, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer;
525
- function execFileSync(command: string, args?: ReadonlyArray<string>, options?: ExecFileSyncOptions): Buffer;
526
- }