Skip to main content

LensStudio:Event.js.Event

Class

A type-safe event emitter that supports adding, removing, and triggering listeners.

A type-safe event emitter that supports adding, removing, and triggering listeners. Provides functionality for one-time listeners, error handling, and event enabling/disabling.

Index

Examples

// Event without data
const onComplete = new Event<void>();
onComplete.add(() => console.log('Complete!'));
onComplete.trigger();
// Event with data
const onMessage = new Event<string>();
onMessage.add((msg) => console.log('Message:', msg));
onMessage.trigger('Hello World');
// One-time listener with unsubscribe
const onClick = new Event<{x: number, y: number}>();
const unsubscribe = onClick.addOnce((pos) => console.log('Clicked at', pos));
// unsubscribe(); // Can manually unsubscribe before first trigger

Type Parameters

Type ParameterDefault typeDescription
TvoidThe type of data passed to event listeners. Defaults to void for events without data.

Constructors

Constructor

new Event<T>(onError?): Event<T>

Creates a new Event instance.

Parameters

ParameterTypeDescription
onError?(error) => voidOptional error handler for exceptions thrown by listeners. If not provided, errors are logged to the console.

Returns

Event<T>

Methods

add()

add(listener): Unsubscribe

Adds a listener function to the list of listeners for this event.

Parameters

ParameterTypeDescription
listenerEventListener<T>The listener function that processes the event.

Returns

Unsubscribe

A function that removes the listener when called.


addOnce()

addOnce(listener): Unsubscribe

Adds a listener function that will be removed after its first invocation.

Parameters

ParameterTypeDescription
listenerEventListener<T>The listener function to invoke only once.

Returns

Unsubscribe

A function that removes the listener when called (useful for canceling before first trigger).


clear()

clear(): void

Removes all listeners and once listeners for this event.

Returns

void


disable()

disable(): void

Disables triggering of the event.

Returns

void


enable()

enable(): void

Enables triggering of the event.

Returns

void


hasListeners()

hasListeners(): boolean

Returns true if there are any listeners attached.

Returns

boolean

true if at least one listener is attached, false otherwise.


isEnabled()

isEnabled(): boolean

Returns true if the event is enabled.

Returns

boolean

true if the event can be triggered, false if disabled.


listenerCount()

listenerCount(): number

Returns the number of attached listeners.

Returns

number

The total count of regular and one-time listeners.


remove()

remove(listener): void

Removes a specific listener from the list of listeners for this event.

Parameters

ParameterTypeDescription
listenerEventListener<T>The listener function to remove.

Returns

void


trigger()

trigger(...args): void

Triggers the event, calling all registered listeners in the order they were added. Errors in listeners do not prevent subsequent listeners from being called.

Parameters

ParameterType
...argsT extends void ? [] : [T]

Returns

void

Examples

// For Event<void>
event.trigger();
// For Event<string>
event.trigger("Hello");