Class Core<E>`Abstract`

Type Parameters

E extends string = string

Hierarchy

EventEmitter<E>
WithEmitter<E>
- Core

Index

Constructors

Properties

$$isEmitter noEmit

Methods

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

Constructors

constructor

new Core<E>(): Core<E>
Type Parameters
- E extends string = string
Returns Core<E>
Inherited from EventEmitter<E>.constructor
- Defined in node_modules/eventemitter3/index.d.ts:88

Properties

`Readonly` $$isEmitter

$$isEmitter: true

noEmit

noEmit: boolean

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

Methods

$set

$set(pairs: string | Record<string, any>, value?: any, context?: object): void
Parameters
- pairs: string | Record<string, any>
- Optional value: any
- Optional context: object
Returns void
- Defined in src/model/basic/Core.class.ts:7

fire

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

fire$n

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

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Core<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 Core<E>
Inherited from WithEmitter.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Core<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 Core<E>
Inherited from WithEmitter.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): Core<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 Core<E>
Inherited from WithEmitter.listen$n
- Defined in src/model/basic/Emitter.ts:159

readOnly

readOnly<V>(key: string, value: V): void
Type Parameters
- V = any
Parameters
- key: string
- value: V
Returns void
- Defined in src/model/basic/Core.class.ts:22

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): Core<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 Core<E>
Inherited from WithEmitter.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

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

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): Core<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 Core<E>
Inherited from WithEmitter.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): Core<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 Core<E>
Inherited from WithEmitter.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

Generated using TypeDoc