Interface WithEmitter<E>

Type Parameters

E extends string

Hierarchy

IsEmitter
- WithEmitter
  - Core

Index

Properties

$$isEmitter noEmit

Methods

fire fire$n listen listen$1 listen$n setEventChild setEventParent unlisten unlisten$n

Properties

`Readonly` $$isEmitter

$$isEmitter: true

noEmit

noEmit: boolean

set it True, the follow emit will be ignore and then set it False.

Methods

fire

fire<T>(event: T, payload?: PlainObject): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Optional payload: PlainObject
Returns boolean
- Defined in src/model/basic/Emitter.ts:147

fire$n

fire$n(event: string, payload?: PlainObject): WithEmitter<E>
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:151

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): WithEmitter<E>
on
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): WithEmitter<E>
once
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): WithEmitter<E>
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:159

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): WithEmitter<E>
Create parent-child relationships of two evented objects manually. Because this method not mounted on evented object.
Parameters
- child: WithEmitter<string>
- Optional off: boolean
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:178

setEventParent

setEventParent(parent: WithEmitter<string>): WithEmitter<E>
Parameters
- parent: WithEmitter<string>
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:180

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): WithEmitter<E>
off
Type Parameters
- T extends string
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): WithEmitter<E>
split off
Parameters
- event: string
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns WithEmitter<E>
- Defined in src/model/basic/Emitter.ts:167

Generated using TypeDoc