TypedEventEmitter
Class: TypedEventEmitter<T>
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:21
A strongly-typed event emitter.
Example
interface MyEvents {
data: (payload: Buffer) => void;
error: (err: Error) => void;
}
class MyEmitter extends TypedEventEmitter<MyEvents> {}
const e = new MyEmitter();
e.on('data', (buf) => { ... });
Extended by
ShellSocketChatSocketDebugSocketCodeboltSocketBrowserSocketTasksSocketJobsSocketAiTerminalSocketEditorSocketMainSocketLspSocketCapabilitySocketSwarmSocketReviewMergeSocketAgentPortfolioSocketCalendarSocketEpisodicMemorySocketRoadmapSocketProjectStructureSocketUpdateRequestSocketBackgroundAgentSocketKnowledgeSocketFileUpdateIntentSocketPersistentMemorySocketContextAssemblySocketKvStoreSocketEventLogSocketIconViewSocketLocalModelSocketSystemAlertSocketOrchestratorSocketAgentDebugSocketEnvironmentDebugSocket
Type Parameters
| Type Parameter | Description |
|---|---|
T extends Record<string, (...args: any[]) => void> | An interface mapping event names to listener signatures. |
Constructors
Constructor
new TypedEventEmitter<T>(): TypedEventEmitter<T>;
Returns
TypedEventEmitter<T>
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
listeners | protected | Map<string | symbol, Set<(...args: any[]) => void>> | CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24 |
Methods
emit()
emit<K>(event: K, ...args: Parameters<T[K]>): boolean;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:54
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
...args | Parameters<T[K]> |
Returns
boolean
listenerCount()
listenerCount(event: string & keyof T): number;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:75
Parameters
| Parameter | Type |
|---|---|
event | string & keyof T |
Returns
number
off()
off<K>(event: K, listener: T[K]): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:35
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | T[K] |
Returns
this
on()
on<K>(event: K, listener: T[K]): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:27
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | T[K] |
Returns
this
once()
once<K>(event: K, listener: T[K]): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:46
Type Parameters
| Type Parameter |
|---|
K extends string |
Parameters
| Parameter | Type |
|---|---|
event | K |
listener | T[K] |
Returns
this
removeAllListeners()
removeAllListeners(event?: string & keyof T): this;
Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:66
Parameters
| Parameter | Type |
|---|---|
event? | string & keyof T |
Returns
this