Stimulation Options
maxNeuronHops?: number— limit traversal depthonResponse?: (response) => void | Promise<void>— tap into flow and completion (async supported)abortSignal?: AbortSignal— graceful cancelconcurrency?: number— per-run concurrency limitctx?: ICNSStimulationContextStore— reuse context store (in‑process)modality?: TCNSModality— optional modality routing formodalityDendriteafferentPath?: TCNSAfferentPath— optional afferent path selection formodalityDendritestimulationContext?: object— optional user-defined bag for listeners/handlersonDrain?: (drain) => void— called once at the end of every synchronous turn; the batch boundary for state managers (see API reference)
const controller = new AbortController();
const stimulation = cns.stimulate(signal, {
maxNeuronHops: 10, // optional, disabled by default
abortSignal: controller.signal,
onResponse: r => {
// queueLength counts pending + in-flight activations, so zero means the
// whole stimulation is finished - not merely that a batch ended.
if (r.queueLength === 0) console.log('done');
}
});
await stimulation.waitUntilComplete();
Async listeners and failure semantics
- Local
onResponseand all global listeners (added viaaddResponseListener) can be synchronous or asynchronous. - They run in parallel for each response. If any throws or returns a rejected Promise, the
stimulation.waitUntilComplete()Promise rejects. - A dendrite
responsethat throws or returns a rejected Promise also fails the run (a failed task) and rejectswaitUntilComplete()— independent of any listener. - If all listeners are synchronous, CNStra does not introduce extra async deferrals for that response.
⚠️
stimulate()returns aCNSStimulation, not a Promise — the completion Promise is created lazily bywaitUntilComplete(). If you neither await it nor register a listener, a failed run is swallowed silently (not even an unhandled rejection). See Error Handling → Fire-and-forget.
// Async onResponse example (e.g., persist to DB/Redis)
const stimulation = cns.stimulate(signal, {
onResponse: async (r) => {
if (r.outputSignal) {
await repo.save(r.outputSignal);
}
}
});
await stimulation.waitUntilComplete();