A class that provides a custom event channel.

You may bind a callback to an event with on or remove with off; trigger-ing an event fires all callbacks in succession.

Hierarchy

Constructors

Events

EVENT_BEGIN: string = "begin"

Triggered when the Serializer begins transforming a project. EVENT_BEGIN

EVENT_END: string = "end"

Triggered when the Serializer has finished transforming a project. EVENT_END

Methods

  • Remove one or many callbacks. If context is null, removes all callbacks with that function. If callback is null, removes all callbacks for the event. If name is null, removes all bound callbacks for all events.

    Returns Serializer

  • Parameters

    • eventMap: undefined | EventMap
    • Optional context: any

    Returns Serializer

  • Parameters

    • name: undefined | string
    • Optional callback: EventCallback
    • Optional context: any

    Returns Serializer

  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns Serializer

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns Serializer

  • Type Parameters

    • T extends { toObject: any }

    Parameters

    • value: T

    Returns ModelToObject<T>

  • Type Parameters

    • T extends { toObject: any }

    Parameters

    • value: undefined | T

    Returns undefined | ModelToObject<T>

  • toObjectsOptional<T>(value: undefined | T[]): undefined | ModelToObject<T>[]
  • Type Parameters

    • T extends { toObject: any }

    Parameters

    • value: undefined | T[]

    Returns undefined | ModelToObject<T>[]

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns Serializer

Generated using TypeDoc