Add comment on Proxy usage

open-cli-tools · Dec 8, 2023 · 0c64306 · 0c64306
1 parent bdbbe6a
commit 0c64306
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/flow-control/kill-on-signal.ts b/src/flow-control/kill-on-signal.ts
@@ -32,6 +32,9 @@ export class KillOnSignal implements FlowController {
                         return { ...exitInfo, exitCode };
                     }),
                 );
+                // Return a proxy so that mutations happen on the original Command object.
+                // If either `Object.assign()` or `Object.create()` were used, it'd be hard to
+                // reflect the mutations on Command objects referenced by previous flow controllers.
                 return new Proxy(command, {
                     get(target, prop: keyof Command) {
                         return prop === 'close' ? closeStream : target[prop];

diff --git a/src/flow-control/restart-process.ts b/src/flow-control/restart-process.ts
@@ -79,6 +79,9 @@ export class RestartProcess implements FlowController {
                     }),
                 );
 
+                // Return a proxy so that mutations happen on the original Command object.
+                // If either `Object.assign()` or `Object.create()` were used, it'd be hard to
+                // reflect the mutations on Command objects referenced by previous flow controllers.
                 return new Proxy(command, {
                     get(target, prop: keyof Command) {
                         return prop === 'close' ? closeStream : target[prop];