Class GradumEmitter<ModelType, DataKeyType>

constructor

• new GradumEmitter<
      ModelType extends
          GradumModel<any, any, any, any, any> = GradumModel<
          any,
          any,
          any,
          any,
          any,
      >,
      DataKeyType extends KeyType = KeyType,
  >(
      model?: ModelType,
  ): GradumEmitter<ModelType, DataKeyType>

  Type Parameters

  • ModelType extends GradumModel<any, any, any, any, any> = GradumModel<any, any, any, any, any>

    The element's MVC model type.

  • DataKeyType extends KeyType = KeyType

    The key type of the MVC's model.

  Parameters

  • Optionalmodel: ModelType

    The model whose key changes this emitter relays.

  Returns GradumEmitter<ModelType, DataKeyType>

  Description

  Create an emitter, optionally bound to a model so key-path events can be fired against it.

Optionalmodel

add

• add(event: string, callback: (...args: any[]) => void): void
  Function

  add

  Parameters

  • event: string

    The event name.

  • callback: (...args: any[]) => void

    The callback to invoke when the event fires.

  Returns void

  Description

  Register a callback for the given event name.

remove

• remove(event: string, callback?: (...args: any[]) => void): void
  Function

  remove

  Parameters

  • event: string

    The event name.

  • Optionalcallback: (...args: any[]) => void

    The callback to remove. If omitted, all callbacks for the event are removed.

  Returns void

  Description

  Remove a specific callback from the given event, or all callbacks if omitted.

fire

• fire(event: string, ...args: any[]): void
  Function

  fire

  Parameters

  • event: string

    The event name.

  • ...args: any[]

    Arguments passed to each callback.

  Returns void

  Description

  Trigger all callbacks registered for the given event name.

addKey

• addKey(
      callback: (value: any, ...keys: DataKeyType[]) => void,
      ...keys: DataKeyType[],
  ): void
  Function

  addKey

  Parameters

  • callback: (value: any, ...keys: DataKeyType[]) => void

    The callback to register.

  • ...keys: DataKeyType[]

    Ordered path from outermost to innermost key.

  Returns void

  Description

  Register a callback fired when the entry at the given key path changes in the model. The callback receives the new value as its first argument, followed by the key path as spread arguments.

removeKey

• removeKey(
      callback?: (value: any, ...keys: DataKeyType[]) => void,
      ...keys: DataKeyType[],
  ): void
  Function

  removeKey

  Parameters

  • Optionalcallback: (value: any, ...keys: DataKeyType[]) => void

    The callback to remove. If omitted, all callbacks for this path are removed.

  • ...keys: DataKeyType[]

    Ordered path from outermost to innermost key.

  Returns void

  Description

  Remove a specific callback for the given key path, or all callbacks if omitted.

fireKey

• fireKey(value: any, ...keys: DataKeyType[]): void
  Function

  fireKey

  Parameters

  • value: any

    The new value at the key path.

  • ...keys: DataKeyType[]

    Ordered path from outermost to innermost key.

  Returns void

  Description

  Trigger all callbacks registered for the given key path. Called automatically when the model fires a change notification at this path.