-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- max
-
-
-
-
-
- get
-
-
-
-
-
-
-
-
-
- to
-
-
-
-
-Type parameters
- -Hierarchy
--
-
- - EventConsumer - -
Index
-Constructors
-constructor
--
-
-
-
-
-
-
- ----
Class Constructor.
-Type parameters
- -Parameters
--
-
-
-
event: E
---Event object to be encapsulated.
-
-
Returns EventConsumer<T, E>
-
- -
-
Accessors
-count
--
-
-
-
-
-
-
- ----
Forwards into SubEvent.count of the contained event.
-Returns number
-
-
maxSubs
- -
-
-
-
-
-
-
- ----
Forwards into SubEvent.maxSubs of the contained event.
-Returns number
-
-
Methods
-getStat
- -
-
-
-
-
-
-
- ----
Forwards into SubEvent.getStat of the contained event.
-Parameters
--
-
-
-
Optional options: {}
--
-
-
Returns ISubStat
-
- -
-
once
--
-
-
-
-
-
-
- ----
Forwards into SubEvent.once of the contained event.
-Parameters
--
-
-
-
cb: SubFunction<T>
-
- -
-
Optional options: ISubOptions
-
-
Returns Subscription
-
- -
-
subscribe
--
-
-
-
-
-
-
- ----
Forwards into SubEvent.subscribe of the contained event.
-Parameters
--
-
-
-
cb: SubFunction<T>
-
- -
-
Optional options: ISubOptions
-
-
Returns Subscription
-
- -
-
toPromise
- -
-
-
-
-
-
-
- ----
Forwards into SubEvent.toPromise of the contained event.
-Parameters
--
-
-
-
Optional options: {}
--
-
-
Returns Promise<T>
-
- -
-
-
- Generated using TypeDoc
-Class EventConsumer<T, E>
Encapsulates an event object, in order to hide its methods SubEvent.emit and SubEvent.cancelAll, +so the event consumer can only receive the event, but cannot emit it, or cancel other subscriptions.
+It is a non-extendable class, with the same signature as SubEvent, minus emit and cancelAll.
+// Example of using EventConsumer inside a component.
import {SubEvent, EventConsumer} from 'sub-events';
class MyComponent {
private event: SubEvent<string> = new SubEvent(); // internal, send-receive event
readonly safeEvent: EventConsumer<string>; // public, receive-only event container
constructor() {
this.safeEvent = new EventConsumer(this.event);
// or even simpler:
// this.safeEvent = this.event.toConsumer();
// clients can only receive data from such "safeEvent",
// they cannot emit data or cancel other subscriptions.
}
}
+Type Parameters
Accessors
count
- get count(): number
Forwards into SubEvent.count of the contained event.
+Returns number
max
- get maxSubs(): number
Forwards into SubEvent.maxSubs of the contained event.
+Returns number
Methods
get
- get
Stat(options?): ISubStat Forwards into SubEvent.getStat of the contained event.
+Parameters
Optionaloptions: {
    minUse?: number;
}OptionalminUse?: number
Returns ISubStat
once
- once(cb, options?): Subscription
Forwards into SubEvent.once of the contained event.
+Parameters
- cb: SubFunction<T>
Optionaloptions: ISubOptions
Returns Subscription
subscribe
- subscribe(cb, options?): Subscription
Forwards into SubEvent.subscribe of the contained event.
+Parameters
- cb: SubFunction<T>
Optionaloptions: ISubOptions
Returns Subscription
to
- to
Promise(options?): Promise<T> Forwards into SubEvent.toPromise of the contained event.
+Parameters
Optionaloptions: {
    name?: string;
    timeout?: number;
}Optionalname?: stringOptionaltimeout?: number
Returns Promise<T>
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- max
-
-
-
-
-
- cancel
-
-
-
-
-
-
- get
-
-
-
-
-
-
-
-
-
- to
-
-
-
- to
-
-
-
-
-
-
-
-
- Type parameters
--
-
-
-
T = unknown
-
-
Hierarchy
--
-
-
- SubEvent
-
-
-
- - SubEventCount - -
-
Index
-Constructors
-constructor
--
-
-
-
-
-
-
-
Type parameters
--
-
-
-
T = unknown
-
-
Parameters
--
-
-
-
Optional options: IEventOptions<T>
---Configuration Options.
-
-
Returns SubEvent<T>
-
- -
-
Accessors
-count
--
-
-
-
-
-
-
- ----
Current number of live subscriptions.
-Returns number
-
-
maxSubs
- -
-
-
-
-
-
-
- ----
Maximum number of subscribers that can receive events. - Default is 0, meaning
-no limit applies.Newer subscriptions outside of the maximum quota will start - receiving events when the older subscriptions get cancelled.
-It can only be set with the constructor.
-Returns number
-
-
Methods
-cancelAll
- -
-
-
-
-
-
-
- ----
Cancels all existing subscriptions for the event.
-This is a convenience method for some special cases, when you want to cancel all subscriptions - for the event at once. Usually, subscribers just call cancel when they want to cancel their - own subscription.
-This method will always offer much better performance than cancelling each subscription individually, - which may become increasingly important when working with a large number of subscribers.
- -Returns number
-Number of subscriptions cancelled.
-
-
emit
--
-
-
-
-
-
-
- ----
Broadcasts data to all subscribers, according to the emit schedule, - which is synchronous by default.
-Parameters
--
-
-
-
data: T
---Data to be sent, according to the template type.
-
- -
-
Optional options: IEmitOptions
---Event-emitting options.
-
-
Returns SubEvent<T>
-The event object itself.
-
- -
-
getStat
- -
-
-
-
-
-
-
- ----
Retrieves subscriptions statistics, to help with diagnosing subscription leaks.
-For this method to be useful, you need to set option
-namewhen calling subscribe.See also: Diagnostics
- -Parameters
--
-
-
-
Optional options: {}
---Statistics Options:
--
-
minUse: number- Minimum subscription usage/count to be included into the list of named - subscriptions. If subscription is used less times, it will be excluded from thenamedlist.
-
-
-
-
Returns ISubStat
-
- -
-
once
--
-
-
-
-
-
-
- ----
Subscribes to receive just one event, and cancel the subscription immediately.
-You may still want to call cancel on the returned Subscription object, - if you suddenly need to prevent the first event, or to avoid dead once-off - subscriptions that never received their event, and thus were not cancelled.
- -Parameters
--
-
-
-
cb: SubFunction<T>
---Event notification function, invoked after self-cancelling the subscription.
-
- -
-
Optional options: ISubOptions
---Subscription Options.
-
-
Returns Subscription
-Object for cancelling the subscription safely.
-
- -
-
subscribe
--
-
-
-
-
-
-
- ----
Subscribes to the event.
-When subscription is no longer needed, method cancel should be called on the - returned object, to avoid performance degradation caused by abandoned subscribers.
-Method getStat can help with diagnosing leaked subscriptions.
- -Parameters
--
-
-
-
cb: SubFunction<T>
---Event notification callback function.
-
- -
-
Optional options: ISubOptions
---Subscription Options.
-
-
Returns Subscription
-Object for cancelling the subscription safely.
-
- -
-
toConsumer
- -
-
-
-
-
-
-
- ----
Returns a new EventConsumer for the event, which physically hides methods emit and cancelAll.
-This method simplifies creation of a receive-only event object representation.
-
-const e = new SubEvent<number>(); // full-access, emit-receive event - -const c = e.toConsumer(); // the same "e" event, but with receive-only access - -// It is equivalent to the full syntax of: -// const c = new EventConsumer<number>(e); -Type parameters
--
-
-
-
E: SubEvent<T, E>
-
-
Returns EventConsumer<T, E>
-
- -
-
toPromise
- -
-
-
-
-
-
-
- ----
Creates a new subscription as a promise, to resolve with the next received event value, - and cancel the subscription.
-Examples of where it can be useful include:
--
-
- verify that a fast-pace subscription keeps receiving data; -
- peek at fast-pace subscription data for throttled updates; -
- for simpler receive-once / signal async processing logic. -
-try { - const nextValue = await myEvent.toPromise({timeout: 1000}); -} catch(e) { - // Either subscription didn't produce any event after 1 second, - // or myEvent.cancelAll() was called somewhere. -} -The returned promise can reject in two cases:
--
-
- when the timeout has been reached (if set via option
timeout), it rejects withEvent timed outerror;
- - when cancelAll is called on the event object, it rejects with
Event cancellederror.
-
Note that if you use this method consecutively, you can miss events in between, - because the subscription is auto-cancelled after receiving the first event.
- -Parameters
--
-
-
-
Optional options: {}
---Subscription Options:
--
-
-name- for the internal subscription name. Seenamein ISubOptions. - In this context, it is also included within any rejection error.
-
-timeout- sets timeout in ms (whentimeout>= 0), to auto-reject with -Event timed outerror.
-
-
-
-
Returns Promise<T>
-
-
-
- Generated using TypeDoc
-Class SubEvent<T>
Core class, implementing event subscription + emitting the event.
+Type Parameters
Hierarchy (view full)
- SubEvent
Index
Constructors
Accessors
Methods
Accessors
count
- get count(): number
Current number of live subscriptions.
+Returns number
max
- get maxSubs(): number
Maximum number of subscribers that can receive events. +Default is 0, meaning
+no limit applies.Newer subscriptions outside the maximum quota will start +receiving events when the older subscriptions get cancelled.
+It can only be set with the constructor.
+Returns number
Methods
cancel
- cancel
All(): number Cancels all existing subscriptions for the event.
+This is a convenience method for some special cases, when you want to cancel all subscriptions +for the event at once. Usually, subscribers just call cancel when they want to cancel their +own subscription.
+This method will always offer much better performance than cancelling each subscription individually, +which may become increasingly important when working with a large number of subscribers.
+Returns number
Number of subscriptions cancelled.
+
emit
- emit(data, options?): this
Broadcasts data to all subscribers, according to the
+emitschedule, +which is synchronous by default.Parameters
- data: T
Data to be sent, according to the template type.
+ Optionaloptions: IEmitOptionsEvent-emitting options.
+
Returns this
The event object itself.
+- data: T
get
- get
Stat(options?): ISubStat Retrieves subscriptions statistics, to help with diagnosing subscription leaks.
+For this method to be useful, you need to set option
+namewhen calling SubEvent.subscribe.See also: Diagnostics
+Parameters
Optionaloptions: {
    minUse?: number;
}Statistics Options:
+-
+
minUse: number- Minimum subscription usage/count to be included into the list of named +subscriptions. If subscription is used fewer times, it will be excluded from thenamedlist.
+
OptionalminUse?: number
Returns ISubStat
once
- once(cb, options?): Subscription
Subscribes to receive just one event, and cancel the subscription immediately.
+You may still want to call Subscription.cancel on the returned object, +if you suddenly need to prevent the first event, or to avoid dead once-off +subscriptions that never received their event, and thus were not cancelled.
+Parameters
- cb: SubFunction<T>
Event notification function, invoked after self-cancelling the subscription.
+ Optionaloptions: ISubOptionsSubscription Options.
+
Returns Subscription
Object for cancelling the subscription safely.
+- cb: SubFunction<T>
subscribe
- subscribe(cb, options?): Subscription
Subscribes to the event.
+When subscription is no longer needed, method Subscription.cancel should be called on the +returned object, to avoid performance degradation caused by abandoned subscribers.
+Method SubEvent.getStat can help with diagnosing leaked subscriptions.
+Parameters
- cb: SubFunction<T>
Event notification callback function.
+ Optionaloptions: ISubOptionsSubscription Options.
+
Returns Subscription
Object for cancelling the subscription safely.
+- cb: SubFunction<T>
to
- to
Consumer<E>(): EventConsumer<T, E> Returns a new EventConsumer for the event, which physically hides methods SubEvent.emit and SubEvent.cancelAll.
+This method simplifies creation of a receive-only event object representation.
+
+ +const e = new SubEvent<number>(); // full-access, emit-receive event
const c = e.toConsumer(); // the same "e" event, but with receive-only access
// It is equivalent to the full syntax of:
// const c = new EventConsumer<number>(e); +Type Parameters
Returns EventConsumer<T, E>
to
- to
Promise(options?): Promise<T> Creates a new subscription as a promise, to resolve with the next received event value, +and cancel the subscription.
+Examples of where it can be useful include:
+-
+
- verify that a fast-pace subscription keeps receiving data; +
- peek at fast-pace subscription data for throttled updates; +
- for simpler receive-once / signal async processing logic. +
+ +try {
const nextValue = await myEvent.toPromise({timeout: 1000});
} catch(e) {
// Either subscription didn't produce any event after 1 second,
// or myEvent.cancelAll() was called somewhere.
} +The returned promise can reject in two cases:
+-
+
- when the timeout has been reached (if set via option
timeout), it rejects withEvent timed outerror;
+ - when cancelAll is called on the event object, it rejects with
Event cancellederror.
+
Note that if you use this method consecutively, you can miss events in between, +because the subscription is auto-cancelled after receiving the first event.
+Parameters
Optionaloptions: {
    name?: string;
    timeout?: number;
}Subscription Options:
+-
+
-
+
+name- for the internal subscription name. Seenamein ISubOptions. +In this context, it is also included within any rejection error.
+ -
+
+timeout- sets timeout in ms (whentimeout>= 0), to auto-reject with +Event timed outerror.
+
Optionalname?: stringOptionaltimeout?: number
-
+
Returns Promise<T>
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Readonly on
-
-
-
-
-
-
-
-
-
-
- max
-
-
-
-
-
- cancel
-
-
-
-
-
-
- get
-
-
-
-
-
-
-
-
-
- to
-
-
-
- to
-
-
-
-
-Type parameters
--
-
-
-
T = unknown
-
-
Hierarchy
--
-
-
- SubEvent<T>
-
-
-
- - SubEventCount - -
-
Index
-Constructors
-constructor
--
-
-
-
-
-
-
-
Type parameters
--
-
-
-
T = unknown
-
-
Parameters
--
-
-
-
Optional options: ICountOptions<T>
---Configuration Options.
-
-
Returns SubEventCount<T>
-
- -
-
Events
-Readonly onCount
-
-
-
-
-
-
- Triggered on any change in the number of subscriptions.
-Accessors
-count
--
-
-
-
-
-
-
- ----
Current number of live subscriptions.
-Returns number
-
-
maxSubs
- -
-
-
-
-
-
-
- ----
Maximum number of subscribers that can receive events. - Default is 0, meaning
-no limit applies.Newer subscriptions outside of the maximum quota will start - receiving events when the older subscriptions get cancelled.
-It can only be set with the constructor.
-Returns number
-
-
Methods
-cancelAll
- -
-
-
-
-
-
-
- ----
Cancels all existing subscriptions for the event.
-It overrides the base implementation, to trigger event onCount - when there was at least one subscription.
- -Returns number
-Number of subscriptions cancelled.
-
-
emit
--
-
-
-
-
-
-
- ----
Broadcasts data to all subscribers, according to the emit schedule, - which is synchronous by default.
-Parameters
--
-
-
-
data: T
---Data to be sent, according to the template type.
-
- -
-
Optional options: IEmitOptions
---Event-emitting options.
-
-
Returns SubEventCount<T>
-The event object itself.
-
- -
-
getStat
- -
-
-
-
-
-
-
- ----
Retrieves subscriptions statistics, to help with diagnosing subscription leaks.
-For this method to be useful, you need to set option
-namewhen calling subscribe.See also: Diagnostics
- -Parameters
--
-
-
-
Optional options: {}
---Statistics Options:
--
-
minUse: number- Minimum subscription usage/count to be included into the list of named - subscriptions. If subscription is used less times, it will be excluded from thenamedlist.
-
-
-
-
Returns ISubStat
-
- -
-
once
--
-
-
-
-
-
-
- ----
Subscribes to receive just one event, and cancel the subscription immediately.
-You may still want to call cancel on the returned Subscription object, - if you suddenly need to prevent the first event, or to avoid dead once-off - subscriptions that never received their event, and thus were not cancelled.
- -Parameters
--
-
-
-
cb: SubFunction<T>
---Event notification function, invoked after self-cancelling the subscription.
-
- -
-
Optional options: ISubOptions
---Subscription Options.
-
-
Returns Subscription
-Object for cancelling the subscription safely.
-
- -
-
subscribe
--
-
-
-
-
-
-
- ----
Subscribes to the event.
-When subscription is no longer needed, method cancel should be called on the - returned object, to avoid performance degradation caused by abandoned subscribers.
-Method getStat can help with diagnosing leaked subscriptions.
- -Parameters
--
-
-
-
cb: SubFunction<T>
---Event notification callback function.
-
- -
-
Optional options: ISubOptions
---Subscription Options.
-
-
Returns Subscription
-Object for cancelling the subscription safely.
-
- -
-
toConsumer
- -
-
-
-
-
-
-
- ----
Returns a new EventConsumer for the event, which physically hides methods emit and cancelAll.
-This method simplifies creation of a receive-only event object representation.
-
-const e = new SubEvent<number>(); // full-access, emit-receive event - -const c = e.toConsumer(); // the same "e" event, but with receive-only access - -// It is equivalent to the full syntax of: -// const c = new EventConsumer<number>(e); -Type parameters
--
-
-
-
E: SubEvent<T, E>
-
-
Returns EventConsumer<T, E>
-
- -
-
toPromise
- -
-
-
-
-
-
-
- ----
Creates a new subscription as a promise, to resolve with the next received event value, - and cancel the subscription.
-Examples of where it can be useful include:
--
-
- verify that a fast-pace subscription keeps receiving data; -
- peek at fast-pace subscription data for throttled updates; -
- for simpler receive-once / signal async processing logic. -
-try { - const nextValue = await myEvent.toPromise({timeout: 1000}); -} catch(e) { - // Either subscription didn't produce any event after 1 second, - // or myEvent.cancelAll() was called somewhere. -} -The returned promise can reject in two cases:
--
-
- when the timeout has been reached (if set via option
timeout), it rejects withEvent timed outerror;
- - when cancelAll is called on the event object, it rejects with
Event cancellederror.
-
Note that if you use this method consecutively, you can miss events in between, - because the subscription is auto-cancelled after receiving the first event.
- -Parameters
--
-
-
-
Optional options: {}
---Subscription Options:
--
-
-name- for the internal subscription name. Seenamein ISubOptions. - In this context, it is also included within any rejection error.
-
-timeout- sets timeout in ms (whentimeout>= 0), to auto-reject with -Event timed outerror.
-
-
-
-
Returns Promise<T>
-
-
-
- Generated using TypeDoc
-Class SubEventCount<T>
Type Parameters
Hierarchy (view full)
Constructors
constructor
- new
Sub Event Count<T>(options?): SubEventCount<T> Event constructor.
+Type Parameters
Parameters
Optionaloptions: ICountOptions<T>Configuration Options.
+
Returns SubEventCount<T>
Accessors
count
- get count(): number
Current number of live subscriptions.
+Returns number
max
- get maxSubs(): number
Maximum number of subscribers that can receive events. +Default is 0, meaning
+no limit applies.Newer subscriptions outside the maximum quota will start +receiving events when the older subscriptions get cancelled.
+It can only be set with the constructor.
+Returns number
Methods
cancel
- cancel
All(): number Cancels all existing subscriptions for the event.
+It overrides the base implementation, to trigger event onCount +when there was at least one subscription.
+Returns number
Number of subscriptions cancelled.
+
emit
- emit(data, options?): this
Broadcasts data to all subscribers, according to the
+emitschedule, +which is synchronous by default.Parameters
- data: T
Data to be sent, according to the template type.
+ Optionaloptions: IEmitOptionsEvent-emitting options.
+
Returns this
The event object itself.
+- data: T
get
- get
Stat(options?): ISubStat Retrieves subscriptions statistics, to help with diagnosing subscription leaks.
+For this method to be useful, you need to set option
+namewhen calling SubEvent.subscribe.See also: Diagnostics
+Parameters
Optionaloptions: {
    minUse?: number;
}Statistics Options:
+-
+
minUse: number- Minimum subscription usage/count to be included into the list of named +subscriptions. If subscription is used fewer times, it will be excluded from thenamedlist.
+
OptionalminUse?: number
Returns ISubStat
once
- once(cb, options?): Subscription
Subscribes to receive just one event, and cancel the subscription immediately.
+You may still want to call Subscription.cancel on the returned object, +if you suddenly need to prevent the first event, or to avoid dead once-off +subscriptions that never received their event, and thus were not cancelled.
+Parameters
- cb: SubFunction<T>
Event notification function, invoked after self-cancelling the subscription.
+ Optionaloptions: ISubOptionsSubscription Options.
+
Returns Subscription
Object for cancelling the subscription safely.
+- cb: SubFunction<T>
subscribe
- subscribe(cb, options?): Subscription
Subscribes to the event.
+When subscription is no longer needed, method Subscription.cancel should be called on the +returned object, to avoid performance degradation caused by abandoned subscribers.
+Method SubEvent.getStat can help with diagnosing leaked subscriptions.
+Parameters
- cb: SubFunction<T>
Event notification callback function.
+ Optionaloptions: ISubOptionsSubscription Options.
+
Returns Subscription
Object for cancelling the subscription safely.
+- cb: SubFunction<T>
to
- to
Consumer<E>(): EventConsumer<T, E> Returns a new EventConsumer for the event, which physically hides methods SubEvent.emit and SubEvent.cancelAll.
+This method simplifies creation of a receive-only event object representation.
+
+ +const e = new SubEvent<number>(); // full-access, emit-receive event
const c = e.toConsumer(); // the same "e" event, but with receive-only access
// It is equivalent to the full syntax of:
// const c = new EventConsumer<number>(e); +Type Parameters
Returns EventConsumer<T, E>
to
- to
Promise(options?): Promise<T> Creates a new subscription as a promise, to resolve with the next received event value, +and cancel the subscription.
+Examples of where it can be useful include:
+-
+
- verify that a fast-pace subscription keeps receiving data; +
- peek at fast-pace subscription data for throttled updates; +
- for simpler receive-once / signal async processing logic. +
+ +try {
const nextValue = await myEvent.toPromise({timeout: 1000});
} catch(e) {
// Either subscription didn't produce any event after 1 second,
// or myEvent.cancelAll() was called somewhere.
} +The returned promise can reject in two cases:
+-
+
- when the timeout has been reached (if set via option
timeout), it rejects withEvent timed outerror;
+ - when cancelAll is called on the event object, it rejects with
Event cancellederror.
+
Note that if you use this method consecutively, you can miss events in between, +because the subscription is auto-cancelled after receiving the first event.
+Parameters
Optionaloptions: {
    name?: string;
    timeout?: number;
}Subscription Options:
+-
+
-
+
+name- for the internal subscription name. Seenamein ISubOptions. +In this context, it is also included within any rejection error.
+ -
+
+timeout- sets timeout in ms (whentimeout>= 0), to auto-reject with +Event timed outerror.
+
Optionalname?: stringOptionaltimeout?: number
-
+
Returns Promise<T>
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Represents an event subscription, and a safe way to cancel it.
- -Hierarchy
--
-
- - Subscription - -
Index
-Properties
-Optional Readonly name
- - -
-
-
-
- Subscription's name option, if it was set with method subscribe.
Accessors
-live
--
-
-
-
-
-
-
- ----
Indicates whether the subscription is live / active.
-It can be useful to subscribers when cancelAll is used without their knowledge.
-Returns boolean
-
-
Methods
-cancel
--
-
-
-
-
-
-
- ----
Cancels the live subscription. The subscriber won't receive any more events.
-It also sets flag live to
- -false.Returns boolean
--
-
true- subscription has been successfully cancelled
- false- nothing happened, as subscription wasn't live
-
-
-
- Generated using TypeDoc
-Class Subscription
Represents an event subscription, and a safe way to cancel it.
+ Properties
Optional Readonlyname
name?: string
Subscription's name option, if it was set with method SubEvent.subscribe.
Accessors
live
- get live(): boolean
Indicates whether the subscription is live / active.
+It can be useful to subscribers when SubEvent.cancelAll is used without their knowledge.
+Returns boolean
Methods
cancel
- cancel(): boolean
Cancels the live subscription. The subscriber won't receive any more events.
+It also sets flag live to
+false.Returns boolean
-
+
true- subscription has been successfully cancelled
+false- nothing happened, as subscription wasn't live
+
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Schedule for emitting / broadcasting data to subscribers, to be used by method emit. - It represents a concurrency strategy for delivering event to subscribers.
-Index
-Enumeration members
-async
- - -
-
-
-
- Data broadcast is fully asynchronous: each subscriber will be receiving the event - within its own processor tick (under Node.js), or timer tick (in browsers).
-Subscribers are enumerated after the initial delay.
-next
- - -
-
-
-
- Wait for the next processor tick (under Node.js), or timer tick (in browsers), - and then broadcast data to all subscribers synchronously.
-Subscribers are enumerated after the delay.
-sync
- - -
-
-
-
- Data is sent to all subscribers synchronously / immediately.
-This is the default schedule.
-
-
- Generated using TypeDoc
-Enumeration EmitSchedule
Schedule for emitting / broadcasting data to subscribers, to be used by method SubEvent.emit. +It represents a concurrency strategy for delivering event to subscribers.
+ Enumeration Members
async
async: "async"
Data broadcast is fully asynchronous: each subscriber will be receiving the event +within its own processor tick (under Node.js), or timer tick (in browsers).
+Subscribers are enumerated after the initial delay.
+next
next: "next"
Wait for the next processor tick (under Node.js), or timer tick (in browsers), +and then broadcast data to all subscribers synchronously.
+Subscribers are enumerated after the delay.
+sync
sync: "sync"
Data is sent to all subscribers synchronously / immediately.
+This is the default schedule.
+
diff --git a/index.html b/index.html
index 9c5dda7..a8e91e6 100644
--- a/index.html
+++ b/index.html
@@ -1,3184 +1,35 @@
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
- Sub
-
-
-
-
-
-
-
-
-
-
- Strongly-Typed Events
- -Lightweight, strongly-typed events, with monitored subscriptions.
- - -Install
- -npm i sub-events
-Usage
- --
-
- On event-provider side: -
import {SubEvent} from 'sub-events';
-
-// creating a strongly-typed event:
-const e: SubEvent<string> = new SubEvent();
-
-// triggering the event when needed:
-e.emit('hello');
--
-
- On event-consumer side: -
// subscribing to the event:
-const sub = e.subscribe((data: string) => {
- // data = 'hello'
-});
-
-// cancel the subscription when no longer needed:
-sub.cancel();
-API: Subscription, subscribe, cancel
- -Monitoring Subscriptions
- -Class SubEventCount extends SubEvent with event onCount, to observe the number of subscriptions:
-import {SubEventCount, ISubCountChange} from 'sub-events';
-
-// creating a strongly-typed event:
-const e: SubEventCount<string> = new SubEventCount();
-
-e.onCount.subscribe((info: ISubCountChange) => {
- // number of subscriptions has changed;
- // info = {newCount, prevCount}
-});
-
-// any subscription will trigger event onCount:
-const sub = e.subscribe(data => {});
-
-// cancelling a subscription will trigger onCount:
-sub.cancel();
-API: SubEventCount, onCount
- -Browser
- -When including directly from HTML, you can access all types under subEvents namespace:
<script src="./node_modules/sub-events/dist"></script>
-<script>
- const e = new subEvents.SubEvent();
- e.subscribe(data => {
- // data received
- });
-</script>
-Note that pre-built script includes only the core library, without the Extras, - which you can bundle yourself as needed.
-Index
-
-
-
-
-
-
-
-
-
-
- Enumerations
--
-
- Emit
Schedule
-
Classes
--
-
- Event
Consumer
- - Sub
Event
- - Sub
Event Count
- - Subscription -
Interfaces
--
-
- ICount
Options
- - IEmit
Options
- - IEvent
Options
- - ISub
Context
- - ISub
Count Change
- - ISub
Options
- - ISub
Stat
-
Type aliases
--
-
- Sub
Function
-
Type aliases
-SubFunction
-
-
-
-
-
-
- Subscription callback function type.
-Type parameters
--
-
-
-
T
-
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
data: T
-
-
Returns any
-
- -
-
- -
-
-
- Generated using TypeDoc
-SUB-EVENTS v1.9.1
Strongly-Typed Events
Lightweight, strongly-typed events, with monitored subscriptions.
+ +Install
npm i sub-events
+Usage
-
+
- On event-provider side: +
import {SubEvent} from 'sub-events';
// creating a strongly-typed event:
const e: SubEvent<string> = new SubEvent();
// triggering the event when needed:
e.emit('hello');
+-
+
- On event-consumer side: +
// subscribing to the event:
const sub = e.subscribe((data: string) => {
// data = 'hello'
});
// cancel the subscription when no longer needed:
sub.cancel();
+API: Subscription, subscribe, cancel
+Monitoring Subscriptions
Class SubEventCount extends SubEvent with event onCount, to observe the number of subscriptions:
+import {SubEventCount, ISubCountChange} from 'sub-events';
// creating a strongly-typed event:
const e: SubEventCount<string> = new SubEventCount();
e.onCount.subscribe((info: ISubCountChange) => {
// number of subscriptions has changed;
// info = {newCount, prevCount}
});
// any subscription will trigger event onCount:
const sub = e.subscribe(data => {});
// cancelling a subscription will trigger onCount:
sub.cancel();
+API: SubEventCount, onCount
+Browser
When including directly from HTML, you can access all types under subEvents namespace:
<script src="./node_modules/sub-events/dist"></script>
<script>
const e = new subEvents.SubEvent();
e.subscribe(data => {
// data received
});
</script>
+Note that pre-built script includes only the core library, without the Extras, +which you can bundle yourself as needed.
+
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional emit
-
-
-
-
-
- Optional max
-
-
-
-
-
- Optional on
-
-
-
-
-
- Optional on
-
-
-
-
-
-
-
-
-
-
- Constructor options for SubEventCount class.
-Type parameters
--
-
-
-
T
-
-
Hierarchy
--
-
-
- IEventOptions<T>
-
-
-
- - ICountOptions - -
-
Index
-
-
-
-
- Properties
--
-
- emit
Options
- - max
Subs
- - on
Cancel
- - on
Subscribe
-
Properties
-Optional emitOptions
-
-
-
-
-
-
- Emit options for event onCount.
-Optional maxSubs
-
-
-
-
-
-
- Maximum number of subscribers that can receive events.
- Default is 0, meaning no limit applies.
Newer subscriptions outside of the maximum quota will start - receiving events when the older subscriptions get cancelled.
-Optional onCancel
-
-
-
-
-
-
- Notification about a cancelled subscription.
-(ctx: ISubContext<T>) => void;
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
ctx: ISubContext<T>
-
-
Returns void
-
- -
-
- -
-
Optional onSubscribe
-
-
-
-
-
-
- Notification of a new subscriber being registered.
-(ctx: ISubContext<T>) => void;
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
ctx: ISubContext<T>
-
-
Returns void
-
- -
-
- -
-
-
- Generated using TypeDoc
-Interface ICountOptions<T>
Constructor options for SubEventCount class.
+interface ICountOptions<T> {
    emitOptions?: IEmitOptions;
    maxSubs?: number;
    onCancel?: ((ctx: ISubContext<T>) => void);
    onSubscribe?: ((ctx: ISubContext<T>) => void);
}
    emitOptions?: IEmitOptions;
    maxSubs?: number;
    onCancel?: ((ctx: ISubContext<T>) => void);
    onSubscribe?: ((ctx: ISubContext<T>) => void);
}
Type Parameters
Hierarchy (view full)
- IEventOptions<T>
- ICountOptions
Index
Properties
Properties
Optionalemit
Emit options for event SubEventCount.onCount.
+Optionalmax
max
Maximum number of subscribers that can receive events.
+Default is 0, meaning no limit applies.
Newer subscriptions outside the maximum quota will start +receiving events when the older subscriptions get cancelled.
+Optionalon
Notification about a cancelled subscription.
+(ctx: ISubContext<T>) => void;
+Type declaration
- (ctx): void
Parameters
- ctx: ISubContext<T>
+ctx: ISubContext - Subscription Context.
Returns void
- ctx: ISubContext<T>
Optionalon
Notification of a new subscriber being registered.
+(ctx: ISubContext<T>) => void;
+Type declaration
- (ctx): void
Parameters
- ctx: ISubContext<T>
+ctx: ISubContext - Subscription Context.
Returns void
- ctx: ISubContext<T>
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
- Optional on
-
-
-
-
-
- Optional on
-
-
-
-
-
-
-
-
-
-
-
-
-
- Options to be used with method emit.
-Hierarchy
--
-
- - IEmitOptions - -
Index
-
-
-
-
- Properties
--
-
- on
Error
- - on
Finished
- - schedule -
Properties
-Optional onError
-
-
-
-
-
-
- Callback for catching all unhandled errors from subscribers, - from both synchronous and asynchronous subscription functions.
-(err: any, name?: string) => void;
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
err: any
-
- -
-
Optional name: string
-
-
Returns void
-
- -
-
- -
-
Optional onFinished
-
-
-
-
-
-
- Notification callback of when the last recipient has received the data. - Note that asynchronous subscribers may still be processing the data at this point.
-(count: number) => void;
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
count: number
-
-
Returns void
-
- -
-
- -
-
Optional schedule
- - -
-
-
-
- Event-emitting schedule. Default is sync.
-
- Generated using TypeDoc
-Interface IEmitOptions
Options to be used with method SubEvent.emit.
+interface IEmitOptions {
    onError?: ((err: any, name?: string) => void);
    onFinished?: ((count: number) => void);
    schedule?: EmitSchedule;
}
    onError?: ((err: any, name?: string) => void);
    onFinished?: ((count: number) => void);
    schedule?: EmitSchedule;
}
Index
Properties
Properties
Optionalon
on
Callback for catching all unhandled errors from subscribers, +from both synchronous and asynchronous subscription functions.
+(err: any, name?: string) => void;
+Type declaration
- (err, name?): void
Parameters
- err: any
+err: The error that was thrown or rejected. Optionalname: string
+name: The subscriptionname, if set during SubEvent.subscribe call.
Returns void
- err: any
Optionalon
on
Notification callback of when the last recipient has received the data. +Note that asynchronous subscribers may still be processing the data at this point.
+(count: number) => void;
+Type declaration
- (count): void
Parameters
- count: number
+count: Total number of subscribers that have received the data.
Returns void
- count: number
Optionalschedule
Event-emitting schedule. Default is sync.
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional max
-
-
-
-
-
- Optional on
-
-
-
-
-
- Optional on
-
-
-
-
-
-
-
-
-
-
- Constructor options for SubEvent class.
-Type parameters
--
-
-
-
T
-
-
Hierarchy
--
-
-
- IEventOptions
-
-
-
- - ICountOptions - -
-
Index
-
-
-
-
- Properties
--
-
- max
Subs
- - on
Cancel
- - on
Subscribe
-
Properties
-Optional maxSubs
-
-
-
-
-
-
- Maximum number of subscribers that can receive events.
- Default is 0, meaning no limit applies.
Newer subscriptions outside of the maximum quota will start - receiving events when the older subscriptions get cancelled.
-Optional onCancel
-
-
-
-
-
-
- Notification about a cancelled subscription.
-(ctx: ISubContext<T>) => void;
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
ctx: ISubContext<T>
-
-
Returns void
-
- -
-
- -
-
Optional onSubscribe
-
-
-
-
-
-
- Notification of a new subscriber being registered.
-(ctx: ISubContext<T>) => void;
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
ctx: ISubContext<T>
-
-
Returns void
-
- -
-
- -
-
-
- Generated using TypeDoc
-Interface IEventOptions<T>
Constructor options for SubEvent class.
+interface IEventOptions<T> {
    maxSubs?: number;
    onCancel?: ((ctx: ISubContext<T>) => void);
    onSubscribe?: ((ctx: ISubContext<T>) => void);
}
    maxSubs?: number;
    onCancel?: ((ctx: ISubContext<T>) => void);
    onSubscribe?: ((ctx: ISubContext<T>) => void);
}
Type Parameters
Hierarchy (view full)
- IEventOptions
Index
Properties
Properties
Optionalmax
max
Maximum number of subscribers that can receive events.
+Default is 0, meaning no limit applies.
Newer subscriptions outside the maximum quota will start +receiving events when the older subscriptions get cancelled.
+Optionalon
Notification about a cancelled subscription.
+(ctx: ISubContext<T>) => void;
+Type declaration
- (ctx): void
Parameters
- ctx: ISubContext<T>
+ctx: ISubContext - Subscription Context.
Returns void
- ctx: ISubContext<T>
Optionalon
Notification of a new subscriber being registered.
+(ctx: ISubContext<T>) => void;
+Type declaration
- (ctx): void
Parameters
- ctx: ISubContext<T>
+ctx: ISubContext - Subscription Context.
Returns void
- ctx: ISubContext<T>
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Subscription Context Interface, as used with onSubscribe and onCancel - notification options that can be set during SubEvent construction.
-Type parameters
--
-
-
-
T = unknown
-
-
Hierarchy
--
-
- - ISubContext - -
Index
-Properties
-Optional data
- - -
-
-
-
- Unknown-type data to let event wrappers persist any - context they need within the event's lifecycle.
-Readonly event
- - -
-
-
-
- Event object that provides the context.
-Optional Readonly name
- - -
-
-
-
- Subscription name, if one was specified with method subscribe.
-
-
- Generated using TypeDoc
-Interface ISubContext<T>
Subscription Context Interface, as used with IEventOptions.onSubscribe and IEventOptions.onCancel +notification options that can be set during SubEvent construction.
+Type Parameters
Properties
Optionaldata
data?: any
Unknown-type data to let event wrappers persist any +context they need within the event's lifecycle.
+Readonlyevent
Event object that provides the context.
+Optional Readonlyname
name?: string
Subscription name, if one was specified with method SubEvent.subscribe.
+
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
- new
-
-
-
-
-
- prev
-
-
-
-
-
-
-
-
-
-
- Represents a change in the number of subscriptions, as used with onCount event.
-Hierarchy
--
-
- - ISubCountChange - -
Index
-Properties
-newCount
-
-
-
-
-
-
- New number of subscriptions.
-prevCount
-
-
-
-
-
-
- Previous number of subscriptions.
-
-
- Generated using TypeDoc
-Interface ISubCountChange
Represents a change in the number of subscriptions, as used with SubEventCount.onCount event.
+
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Optional on
-
-
-
-
-
- Optional this
-
-
-
-
-
-
-
-
-
-
- Options that can be passed into method subscribe.
-Hierarchy
--
-
- - ISubOptions - -
Index
-Properties
-Optional name
- - -
-
-
-
-
- Unique subscription name. It helps with diagnosing subscription leaks, - via method getStat, and provides additional details during error handling. - The name should help identify place in the code where the subscription was created.
-Optional onCancel
-
-
-
-
-
-
- Subscription-cancel callback, to be notified on subscription explicit - cancel call, or when cancelled implicitly via cancelAll.
-This is mostly for internal usage, and has no protection against - errors, should the handler throw any.
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Returns void
-
-
- -
-
Optional thisArg
-
-
-
-
-
-
- Calling / this context for the subscription callback function.
Standard way of passing in context is this way:
-event.subscribe(func.bind(this))
-With this option you can also do it this way:
-event.subscribe(func, {thisArg: this})
-
-
- Generated using TypeDoc
-Interface ISubOptions
Options that can be passed into method SubEvent.subscribe.
+interface ISubOptions {
    name?: string;
    onCancel?: (() => void);
    thisArg?: any;
}
    name?: string;
    onCancel?: (() => void);
    thisArg?: any;
}
Properties
Optionalname
name?: string
Unique subscription name. It helps with diagnosing subscription leaks, +via method SubEvent.getStat, and provides additional details during error handling. +The name should help identify place in the code where the subscription was created.
+Optionalon
on
Subscription-cancel callback, to be notified on subscription explicit +Subscription.cancel call, or when cancelled implicitly via SubEvent.cancelAll.
+This is mostly for internal usage, and has no protection against +errors, should the handler throw any.
+Optionalthis
this
Calling / this context for the subscription callback function.
Standard way of passing in context is this way:
+event.subscribe(func.bind(this))
+With this option you can also do it this way:
+event.subscribe(func, {thisArg: this})
+
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Subscriptions statistics, as returned by method getStat.
-Hierarchy
--
-
- - ISubStat - -
Index
-Properties
-named
- - -
-
-
-
- Map of subscription names to their usage counters. It consists of only
- subscriptions for which option name was set when calling subscribe.
-
- Type declaration
--
-
-
-
[name: string]: number
-
-
unnamed
- - -
-
-
-
- Total number of unnamed subscriptions.
-
-
- Generated using TypeDoc
-Interface ISubStat
Subscriptions statistics, as returned by method SubEvent.getStat.
+interface ISubStat {
    named: {
        [name: string]: number;
    };
    unnamed: number;
}
    named: {
        [name: string]: number;
    };
    unnamed: number;
}
Properties
named
named: {
    [name: string]: number;
}
    [name: string]: number;
}
Map of subscription names to their usage counters. It consists of only
+subscriptions for which option name was set when calling SubEvent.subscribe.
unnamed
unnamed: number
Total number of unnamed subscriptions.
+
-
-
-
-
\ No newline at end of file
+
-
-
-
-
-
-
-
- Sub
-
-
-
-
-
-
-
-
-
- Strongly-Typed Events
- -Lightweight, strongly-typed events, with monitored subscriptions.
- - -Install
- -npm i sub-events
-Usage
- --
-
- On event-provider side: -
import {SubEvent} from 'sub-events';
-
-// creating a strongly-typed event:
-const e: SubEvent<string> = new SubEvent();
-
-// triggering the event when needed:
-e.emit('hello');
--
-
- On event-consumer side: -
// subscribing to the event:
-const sub = e.subscribe((data: string) => {
- // data = 'hello'
-});
-
-// cancel the subscription when no longer needed:
-sub.cancel();
-API: Subscription, subscribe, cancel
- -Monitoring Subscriptions
- -Class SubEventCount extends SubEvent with event onCount, to observe the number of subscriptions:
-import {SubEventCount, ISubCountChange} from 'sub-events';
-
-// creating a strongly-typed event:
-const e: SubEventCount<string> = new SubEventCount();
-
-e.onCount.subscribe((info: ISubCountChange) => {
- // number of subscriptions has changed;
- // info = {newCount, prevCount}
-});
-
-// any subscription will trigger event onCount:
-const sub = e.subscribe(data => {});
-
-// cancelling a subscription will trigger onCount:
-sub.cancel();
-API: SubEventCount, onCount
- -Browser
- -When including directly from HTML, you can access all types under subEvents namespace:
<script src="./node_modules/sub-events/dist"></script>
-<script>
- const e = new subEvents.SubEvent();
- e.subscribe(data => {
- // data received
- });
-</script>
-Note that pre-built script includes only the core library, without the Extras, - which you can bundle yourself as needed.
-Index
-
-
-
-
-
-
-
-
-
-
- Enumerations
--
-
- Emit
Schedule
-
Classes
--
-
- Event
Consumer
- - Sub
Event
- - Sub
Event Count
- - Subscription -
Interfaces
--
-
- ICount
Options
- - IEmit
Options
- - IEvent
Options
- - ISub
Context
- - ISub
Count Change
- - ISub
Options
- - ISub
Stat
-
Type aliases
--
-
- Sub
Function
-
Type aliases
-SubFunction
-
-
-
-
-
-
- Subscription callback function type.
-Type parameters
--
-
-
-
T
-
-
-
- Type declaration
--
-
-
-
-
-
-
-
-
-
-
Parameters
--
-
-
-
data: T
-
-
Returns any
-
- -
-
- -
-
-
- Generated using TypeDoc
-
class EventConsumer<T = unknown, E extends SubEvent<T> = SubEvent<T>>
- -Encapsulates an event object, in order to hide its methods emit and cancelAll, so the event - consumer can only receive the event, but cannot emit it, or cancel other subscriptions.
-It is a non-extendable class, with the same signature as SubEvent, minus methods emit and cancelAll.
- -