Interface MtsEvents

Dispatches MTS business events.

interface MtsEvents {
    logPrefix: string;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof MtsEventMap): boolean;
    initializePersistence(__namedParameters: MtsEventsPersistenceOptions): void;
    on<K extends keyof MtsEventMap>(
        type: K,
        handler: EventHandler<MtsEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyMtsEvents
- MtsEvents

Implemented by

MtsEventsImpl

Index

Properties

Methods

hasAnyListeners hasListeners initializePersistence on

Properties

`Readonly`logPrefix

logPrefix: string

A string prefix for all log statements made by this target.

Methods

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyMtsEvents.hasAnyListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:30

hasListeners

hasListeners(type: keyof MtsEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof MtsEventMap
Returns boolean
Inherited from ReadonlyMtsEvents.hasListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:34

initializePersistence

initializePersistence(__namedParameters: MtsEventsPersistenceOptions): void
Stores pending events to persistence. If the app is closed before the player unloads a track, these events will be recovered and emitted (asynchronously) when this function is called. Events will be saved to persistence
Parameters
- __namedParameters: MtsEventsPersistenceOptions
Returns void
- Defined in vinyl-amzn/src/metrics/MtsEvents.ts:130

on

on<K extends keyof MtsEventMap>(
    type: K,
    handler: EventHandler<MtsEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof MtsEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<MtsEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyMtsEvents.on
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:26