Class: Emitter<T>
Defined in: base/emitter.ts:9
Extended by
Type Parameters
| Type Parameter |
|---|
T extends string |
Constructors
Constructor
new Emitter<
T>(delayedEmissionTimerConstructor?,alwaysActive?):Emitter<T>
Defined in: base/emitter.ts:27
Parameters
| Parameter | Type |
|---|---|
delayedEmissionTimerConstructor? | (callback) => Timer |
alwaysActive? | boolean |
Returns
Emitter<T>
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
_idleTimer? | protected | Timer | Optional one-shot idle timer owned by subclasses (Repository, Query) that implement inactivity auto-close. The shared listener hook below keeps it unscheduled whenever a DocumentChanged listener is registered. | base/emitter.ts:25 |
alwaysActive | readonly | boolean | - | base/emitter.ts:10 |
Accessors
isActive
Get Signature
get isActive():
boolean
Defined in: base/emitter.ts:63
Returns
boolean
Methods
_onListenersChanged()
protected_onListenersChanged(event):void
Defined in: base/emitter.ts:321
Hook called whenever listeners change for a specific event (attach, detach,
or detachAll). The event argument is the event whose listener set changed,
or undefined for detachAll() with no argument. The default implementation
keeps a subclass-owned _idleTimer in sync with DocumentChanged pins;
_touchIdle() is the subclass-specific reset policy.
Parameters
| Parameter | Type |
|---|---|
event | string |
Returns
void
_touchIdle()
protected_touchIdle():void
Defined in: base/emitter.ts:338
Idle-timer reset hook. Subclasses that own an _idleTimer override this;
the default is a no-op.
Returns
void
attach()
attach<
C,E>(e,c): () =>void
Defined in: base/emitter.ts:139
Type Parameters
| Type Parameter |
|---|
C extends Function |
E extends string |
Parameters
| Parameter | Type |
|---|---|
e | E |
c | C |
Returns
() => void
detach()
detach<
C,E>(e,c):void
Defined in: base/emitter.ts:173
Type Parameters
| Type Parameter |
|---|
C extends Function |
E extends string |
Parameters
| Parameter | Type |
|---|---|
e | E |
c | C |
Returns
void
detachAll()
detachAll<
E>(e?):void
Defined in: base/emitter.ts:214
Type Parameters
| Type Parameter |
|---|
E extends string |
Parameters
| Parameter | Type |
|---|---|
e? | E |
Returns
void
emit()
emit<
E>(e,a0?,a1?):void
Defined in: base/emitter.ts:88
Emits an event to all registered listeners in registration (FIFO) order. This ordering is a stable contract -- chained query listeners depend on it.
Type Parameters
| Type Parameter |
|---|
E extends string |
Parameters
| Parameter | Type |
|---|---|
e | E |
a0? | unknown |
a1? | unknown |
Returns
void
mute()
mute():
void
Defined in: base/emitter.ts:344
Returns
void
once()
once<
C,E>(e,c): () =>void
Defined in: base/emitter.ts:278
Type Parameters
| Type Parameter |
|---|
C extends Function |
E extends string |
Parameters
| Parameter | Type |
|---|---|
e | E |
c | C |
Returns
() => void
resume()
protectedresume():void
Defined in: base/emitter.ts:342
Returns
void
suspend()
protectedsuspend():void
Defined in: base/emitter.ts:340
Returns
void
unmute()
unmute():
void
Defined in: base/emitter.ts:348
Returns
void
Events
listenerCount()
listenerCount(
event):number
Defined in: base/emitter.ts:74
Returns the number of live (non-null) callbacks registered for a given event. Used by lifecycle policies (e.g. auto-close) to derive listener 'pins' from the Emitter's own registrations instead of parallel counters, so detachAll / dedup / missing-detach semantics are always respected.
Parameters
| Parameter | Type |
|---|---|
event | T | EmitterEvent |
Returns
number