Class AbstractComponent<O, E>Abstract

constructor

• new AbstractComponent<
      O extends ComponentHost,
      E extends Record<keyof E, unknown[]>,
  >(
      owner: O,
  ): AbstractComponent<O, E>

  Create new Component instance.

  Type Parameters

  • O extends ComponentHost

    type of component's owner.

  • E extends Record<keyof E, unknown[]>

  Parameters

  • owner: O

  Returns AbstractComponent<O, E>

componentName

application

• get application(): Application

  Return the application / root component instance.

  Returns Application

owner

• get owner(): O

  Return the owner of this component.

  Returns O

off

• off<K extends string | number | symbol>(
      event: K,
      listener: (this: undefined, ...args: E[K]) => void,
  ): void

  Stops listening to an event.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • event: K

    the event to stop listening to.

  • listener: (this: undefined, ...args: E[K]) => void

    the function to remove from the listener array.

  Returns void

on

• on<K extends string | number | symbol>(
      event: K,
      listener: (this: undefined, ...args: E[K]) => void,
      priority?: number,
  ): void

  Starts listening to an event.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • event: K

    the event to listen to.

  • listener: (this: undefined, ...args: E[K]) => void

    function to be called when an this event is emitted.

  • Optionalpriority: number

    optional priority to insert this hook with. Higher priority is placed earlier in the listener array.

  Returns void

trigger

• trigger<K extends string | number | symbol>(event: K, ...args: E[K]): void

  Emits an event to all currently subscribed listeners.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • event: K

    the event to emit.

  • ...args: E[K]

    any arguments required for the event.

  Returns void