From c7586e96ff8ff1bbeb7b8d6b965d4a8a6b8fce3b Mon Sep 17 00:00:00 2001
From: jeromew <jerome.wagner@m4x.org>
Date: Thu, 4 Dec 2025 13:20:17 +0000
Subject: [PATCH] Add comment on `end` worklet param

---
 packages/superdough/helpers.mjs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/packages/superdough/helpers.mjs b/packages/superdough/helpers.mjs
index 6fe1e5b7..f000db63 100644
--- a/packages/superdough/helpers.mjs
+++ b/packages/superdough/helpers.mjs
@@ -613,6 +613,8 @@ export const releaseAudioNode = (node) => {
   // returns true and either its active source flag is true or
   // any AudioNode connected to one of its inputs is actively processing.
   if (node instanceof AudioWorkletNode) {
+    // while `end` is not native to the web audio API, it is common practice in superdough
+    // to use that param in the worklets to trigger returning false from the processor
     node.parameters.get('end')?.setValueAtTime(0, 0);
   }
 };