import {EventEmitter} from '@osjs/event-emitter/osjs-event-emitter/index.js'

public class | source

EventEmitter

A standards compatible event handler (observer) with some sugar.

Constructor Summary

Public Constructor
public	constructor(name: string) Create Event Handler

Member Summary

Public Members
public	events: object Registered events
public	name: string The name of the handler

Method Summary

Public Methods
public	destroy() Destroys all events
public	emit(name: string \| string[], args: *): EventEmitter Emits an event
public	off(name: string \| string[], callback: Function, force: boolean): EventEmitter Removes an event handler
public	on(name: string \| string[], callback: Function, options: object): EventEmitter Add an event handler
public	once(name: , callback: ): EventEmitter Adds an event handler that only fires once

Public Constructors

public constructor(name: string) source

Create Event Handler

Params:

Name	Type	Attribute	Description
name	string	optional	A name for logging

Public Members

public events: object source

Registered events

public name: string source

The name of the handler

Public Methods

public destroy() source

Destroys all events

public emit(name: string | string[], args: *): EventEmitter source

Emits an event

You can supply an array of event names or a comma separated list with a string

Params:

Name	Type	Attribute	Description
name	string \| string[]		Event name
args	*	optional	Arguments

Return:

EventEmitter

Returns current instance

public off(name: string | string[], callback: Function, force: boolean): EventEmitter source

Removes an event handler

If no callback is provided, all events bound to given name will be removed.

You can supply an array of event names or a comma separated list with a string

Params:

Name	Type	Attribute	Description
name	string \| string[]		Event name
callback	Function	optional	Callback function
force	boolean	optional default: false	Forces removal even if set to persis

Return:

EventEmitter

Returns current instance

public on(name: string | string[], callback: Function, options: object): EventEmitter source

Add an event handler

You can supply an array of event names or a comma separated list with a string

Params:

Name	Type	Attribute	Description
name	string \| string[]		Event name
callback	Function		Callback function
options	object	optional	Options
options.persist	boolean	optional	This even handler cannot be removed unless forced
options.once	boolean	optional	Fire only once

Return:

EventEmitter

Returns current instance

public once(name: , callback: ): EventEmitter source

Adds an event handler that only fires once

Params:

Name	Type	Attribute	Description
name	*
callback	*

Return:

EventEmitter

Returns current instance

EventEmitter

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(name: string) source

Params:

Public Members

public events: object source

public name: string source

Public Methods

public destroy() source

public emit(name: string | string[], args: *): EventEmitter source

Params:

Return:

public off(name: string | string[], callback: Function, force: boolean): EventEmitter source

Params:

Return:

public on(name: string | string[], callback: Function, options: object): EventEmitter source

Params:

Return:

public once(name: *, callback: *): EventEmitter source

Params:

Return:

public once(name: , callback: ): EventEmitter source