Class BaseComponent<P, E>

BaseComponent class

Type Parameters

P extends BaseComponentProps<BaseComponentEventMap>
E extends BaseComponentEventMap

Hierarchy

EventSource<E>
- BaseComponent

Index

Constructors

constructor

Methods

_emit _off _on _once _signal defaults disposeTimers emit listen mapPropEvents off on once removeAllListeners removeDefaultHandler setDefaultHandler signal singleShot startTimer stopTimer

Constructors

constructor

new BaseComponent<P, E>(props): BaseComponent<P, E>
Type Parameters
- P extends BaseComponentProps<BaseComponentEventMap, P>
- E extends BaseComponentEventMap
Parameters
- props: P
Returns BaseComponent<P, E>
Overrides EventSource.constructor
- Defined in src/base_component.ts:69

Properties

`Private` #m_timers

#m_timers: Map<string, Function>

`Protected` m_props

m_props: P

Methods

_emit

_emit(eventName, e): void
Parameters
- eventName: string
- e: BasicEvent
Returns void
Inherited from EventSource._emit
- Defined in src/x4events.ts:291

_off

_off(eventName, callback): void
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns void
Inherited from EventSource._off
- Defined in src/x4events.ts:550

_on

_on(eventName, callback, capturing?): EventDisposer
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
- capturing: boolean = false
Returns EventDisposer
Inherited from EventSource._on
- Defined in src/x4events.ts:513

_once

_once(eventName, callback): Promise<unknown>
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns Promise<unknown>
Inherited from EventSource._once
- Defined in src/x4events.ts:412

_signal

_signal(eventName, e, delay?): void
Parameters
- eventName: string
- e: BasicEvent
- delay: number = -1
Returns void
Inherited from EventSource._signal
- Defined in src/x4events.ts:348

defaults

defaults(events): void
define a set of default handlers in one call
Parameters
- events: MapEvents<E>
Returns void
Inherited from EventSource.defaults
- Defined in src/x4events.ts:495

disposeTimers

disposeTimers(): void
stop all timers

Returns void
- Defined in src/base_component.ts:122

emit

emit<K>(type, event?): void
emit an event you can stop propagation of event or prevent default
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- Optional event: E[K]
  
  event data
Returns void
Inherited from EventSource.emit
- Defined in src/x4events.ts:287

listen

listen(events): void
define a set of listeners in one call
Parameters
- events: MapEvents<E>
Returns void
Inherited from EventSource.listen
- Defined in src/x4events.ts:484

mapPropEvents

mapPropEvents<N>(props, ...elements): void
Type Parameters
- N extends string | number | symbol
Parameters
- props: P
- Rest ...elements: N[]
Returns void
- Defined in src/base_component.ts:143

off

off<K>(type, callback): void
stop listening to an event
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to remove (must be the same as in on )
  - - (ev): any
    - Parameters
      
      ev: E[K]
      
      Returns any
Returns void
Inherited from EventSource.off
- Defined in src/x4events.ts:545

on

on<K>(type, callback): EventDisposer
listen for an event
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to call
  - - (ev): any
    - Parameters
      
      ev: E[K]
      
      Returns any
Returns EventDisposer
Inherited from EventSource.on
- Defined in src/x4events.ts:508

once

once<K>(type, callback): void
handle an event one time
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to call when event is signaled
  - - (ev): any
    - Parameters
      
      ev: E[K]
      
      Returns any
Returns void
Promise if callback is null

take care with that because if the event is never fired and you await it, the system may overflow
Inherited from EventSource.once
- Defined in src/x4events.ts:407

removeAllListeners

removeAllListeners(eventName): void
remove all listeners for an event
Parameters
- eventName: string
  
  event name
Returns void
Inherited from EventSource.removeAllListeners
- Defined in src/x4events.ts:571

removeDefaultHandler

removeDefaultHandler(eventName, callback): void
remove the previous default handler installed for an event
Parameters
- eventName: string
  
  event name
- callback: EventCallback<BasicEvent>
  
  callback handler to remove (must be the same as in setDefaultHandler)
Returns void
Inherited from EventSource.removeDefaultHandler
- Defined in src/x4events.ts:464

setDefaultHandler

setDefaultHandler(eventName, callback): void
set the event default handler
Parameters
- eventName: string
  
  name of the event
- callback: EventCallback<BasicEvent>
  
  callback to call when the event is not handled (and preventDeault has not been called)
Returns void
Inherited from EventSource.setDefaultHandler
- Defined in src/x4events.ts:434

signal

signal<K>(type, event, delay?): void
signal en event signaled event are notification : no way to prevent default not stop propagation
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- event: E[K]
  
  event data
- delay: number = -1
Returns void
Inherited from EventSource.signal
- Defined in src/x4events.ts:344

singleShot

singleShot(callback, timeout?): void
Parameters
- callback: TimerCallback
- timeout: number = 0
Returns void
- Defined in src/base_component.ts:133

startTimer

startTimer(name, timeout, repeat?, callback?): void
start a new timer
Parameters
- name: string
  
  timer name
- timeout: number
  
  time out in ms
- repeat: boolean = true
  
  if true this is an auto repeat timer
- callback: TimerCallback = null
  
  if !null, the callback to call else a EvTimer is fired
Returns void
- Defined in src/base_component.ts:88

stopTimer

stopTimer(name): void
stop the given timer
Parameters
- name: string
Returns void
- Defined in src/base_component.ts:113

Class BaseComponent<P, E>

Type Parameters

P extends BaseComponentProps<BaseComponentEventMap>

E extends BaseComponentEventMap

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

P extends BaseComponentProps<BaseComponentEventMap, P>

E extends BaseComponentEventMap

Parameters

props: P

Returns BaseComponent<P, E>

Properties

Private #m_timers

Protected m_props

Methods

_emit

Parameters

eventName: string

e: BasicEvent

Returns void

_off

Parameters

eventName: string

callback: EventCallback<BasicEvent>

Returns void

_on

Parameters

eventName: string

callback: EventCallback<BasicEvent>

capturing: boolean = false

Returns EventDisposer

_once

Parameters

eventName: string

callback: EventCallback<BasicEvent>

Returns Promise<unknown>

_signal

Parameters

eventName: string

e: BasicEvent

delay: number = -1

Returns void

defaults

Parameters

events: MapEvents<E>

Returns void

disposeTimers

Returns void

emit

Type Parameters

K extends string | number | symbol

Parameters

type: K

Optional event: E[K]

Returns void

listen

Parameters

events: MapEvents<E>

Returns void

mapPropEvents

Type Parameters

N extends string | number | symbol

Parameters

props: P

Rest ...elements: N[]

Returns void

off

Type Parameters

K extends string | number | symbol

Parameters

type: K

callback: ((ev) => any)

Parameters

ev: E[K]

`Private` #m_timers

`Protected` m_props

`Optional` event: E[K]

`Rest` ...elements: N[]