ev API

EV
class

The context class for event operations. You can use as it is or inherit any classes in this class.

const dv = new EV();
// or...
class SomeClass extends EV {}

When using it with TypeScript, it is possible to strictly set type information by specifying an interface in Generics.

class SomeClass extends EV<{event1: string, event2: boolean}> {
  constructor() {
    super();
    this.emit('event1', 5); // ng
    this.emit('event1', 'string'); // ok
    this.on('event2', event => {
      const var1: string = event; // ng
      const var2: boolean = event; // ok
    });
  }
}

on
function

# Signature(1 / 6)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any): EVListener

Create and return listener instance by type, handler.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler

# Return Type

EVListener

Create and return listener instance by type, handler.

# Signature(2 / 6)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any, option?: { tag?: EVListenerTag; once?: boolean; }): EVListener

Create and return listener instance by type, handler, option.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler
option	`{ tag?: EVListenerTag; once?: boolean; } \| undefined`
object option

# Return Type

EVListener

Create and return listener instance by type, handler, option.

# Signature(3 / 6)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any, option?: { tag?: EVListenerTag; once?: boolean; }): EVListener

Create and return listener instance by type, handler, option.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler
option	`{ tag?: EVListenerTag; once?: boolean; } \| undefined`
object option

# Return Type

EVListener

Create and return listener instance by type, handler, option.

# Signature(4 / 6)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any, option?: { tag?: EVListenerTag; }, once?: boolean): EVListener

Create and return listener instance by type, handler, once.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler
option	`{ tag?: EVListenerTag; } \| undefined`
object option
once	`boolean \| undefined`
Delete handler with one event firing

# Return Type

EVListener

Create and return listener instance by type, handler, once.

# Signature(5 / 6)

<K extends keyof EventMap>(type: K, option?: { handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; once?: boolean; }): EVListener

Create and return listener instance by type, option.

# Parameters

Name	Type	Default
type*	`K`
event type
option	`{ handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; once?: boolean; } \| undefined`
object option

# Return Type

EVListener

Create and return listener instance by type, option.

# Signature(6 / 6)

<K extends keyof EventMap>(option: { type: K; handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; once?: boolean; }): EVListener

Create and return listener instance by option.

# Parameters

Name	Type	Default
option*	`{ type: K; handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; once?: boolean; }`
object option

# Return Type

EVListener

Create and return listener instance by option.

once
function

# Signature(1 / 4)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any): EVListener

Create and return listener instance by type, handler. This listener is deleted when it detects an event only once.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler

# Return Type

EVListener

Create and return listener instance by type, handler. This listener is deleted when it detects an event only once.

# Signature(2 / 4)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any, option: { tag?: EVListenerTag; }): EVListener

Create and return listener instance by type, handler, option. This listener is deleted when it detects an event only once.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler
option*	`{ tag?: EVListenerTag; }`
object option

# Return Type

EVListener

Create and return listener instance by type, handler, option. This listener is deleted when it detects an event only once.

# Signature(3 / 4)

<K extends keyof EventMap>(type: K, option: { handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; }): EVListener

Create and return listener instance by type, option. This listener is deleted when it detects an event only once.

# Parameters

Name	Type	Default
type*	`K`
event type
option*	`{ handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; }`
object option

# Return Type

EVListener

Create and return listener instance by type, option. This listener is deleted when it detects an event only once.

# Signature(4 / 4)

<K extends keyof EventMap>(option: { type: K; handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; }): EVListener

Create and return listener instance by option. This listener is deleted when it detects an event only once.

# Parameters

Name	Type	Default
option*	`{ type: K; handler: (ev: EventMap[K]) => any; tag?: EVListenerTag; }`
object option

# Return Type

EVListener

Create and return listener instance by option. This listener is deleted when it detects an event only once.

immediate
function

# Signature

<K extends keyof EventMap>(type: K, handler: () => any, option?: { tag?: EVListenerTag; }): EVListener

Create and return listener instance by type, handler. This will be done immediately. When registering this hook, do not expect the payload to be passed to the callback method.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`() => any`
event handler
option	`{ tag?: EVListenerTag; } \| undefined`

# Return Type

EVListener

Create and return listener instance by type, handler. This will be done immediately. When registering this hook, do not expect the payload to be passed to the callback method.

off
function

# Signature(1 / 5)

<K extends keyof EventMap>(type: K): void

Remove listener by type

# Parameters

Name	Type	Default
type*	`K`
event type

# Return Type

void

Remove listener by type

# Signature(2 / 5)

<K extends keyof EventMap>(type: K, handler: (ev: EventMap[K]) => any): void

Remove listener by type and handler.

# Parameters

Name	Type	Default
type*	`K`
event type
handler*	`(ev: EventMap[K]) => any`
event handler

# Return Type

void

Remove listener by type and handler.

# Signature(3 / 5)

<K extends keyof EventMap>(type: K, option: { handler?: (ev: EventMap[K]) => any; tag?: EVListenerTag; }): void

Remove listener by type and option.

# Parameters

Name	Type	Default
type*	`K`
event type
option*	`{ handler?: (ev: EventMap[K]) => any; tag?: EVListenerTag; }`
object option

# Return Type

void

Remove listener by type and option.

# Signature(4 / 5)

<K extends keyof EventMap>(handler: (ev: EventMap[K]) => any): void

Remove listener by handler.

# Parameters

Name	Type	Default
handler*	`(ev: EventMap[K]) => any`
event handler

# Return Type

void

Remove listener by handler.

# Signature(5 / 5)

<K extends keyof EventMap>(option: { type?: K; handler?: (ev: EventMap[K]) => any; tag?: EVListenerTag; }): void

Remove listener by option(tag, handler, tag).

# Parameters

Name	Type	Default
option*	`{ type?: K; handler?: (ev: EventMap[K]) => any; tag?: EVListenerTag; }`
object option

# Return Type

void

Remove listener by option(tag, handler, tag).

offAll
function

# Signature

(): void

Remove all listener instances.

# Parameters

Name	Type	Default

# Return Type

void

Remove all listener instances.

emit
function

# Signature

<K extends keyof EventMap>(type: K, payload: EventMap[K]): void

Emit event.

# Parameters

Name	Type	Default
type*	`K`
event type
payload*	`EventMap[K]`
event payload

# Return Type

void

Emit event.

EVclass

onfunction

# Signature(1 / 6)

# Parameters

# Return Type

# Signature(2 / 6)

# Parameters

# Return Type

# Signature(3 / 6)

# Parameters

# Return Type

# Signature(4 / 6)

# Parameters

# Return Type

# Signature(5 / 6)

# Parameters

# Return Type

# Signature(6 / 6)

# Parameters

# Return Type

oncefunction

# Signature(1 / 4)

# Parameters

# Return Type

# Signature(2 / 4)

# Parameters

# Return Type

# Signature(3 / 4)

# Parameters

# Return Type

# Signature(4 / 4)

# Parameters

# Return Type

immediatefunction

# Signature

# Parameters

# Return Type

offfunction

# Signature(1 / 5)

# Parameters

# Return Type

# Signature(2 / 5)

# Parameters

# Return Type

# Signature(3 / 5)

# Parameters

# Return Type

# Signature(4 / 5)

# Parameters

# Return Type

# Signature(5 / 5)

# Parameters

# Return Type

offAllfunction

# Signature

# Parameters

# Return Type

emitfunction

# Signature

# Parameters

# Return Type

EV
class

on
function

once
function

immediate
function

off
function

offAll
function

emit
function