Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Serializer

Hierarchy

Implements

Index

Constructors

constructor

Events

Static EVENT_BEGIN

EVENT_BEGIN: string = "begin"

Triggered when the Serializer begins transforming a project.

Static EVENT_END

EVENT_END: string = "end"

Triggered when the Serializer has finished transforming a project.

Properties

componentName

componentName: string

The name of this component as set by the @Component decorator.

Private router

router: Map<any, object>

Private routes

routes: any[]

Accessors

application

owner

Methods

addComponent

  • addComponent<T>(name: string, componentClass: T | ComponentClass<T>): T

Protected bubble

Private findRoutes

getComponent

getComponents

getOptionDeclarations

hasComponent

  • hasComponent(name: string): boolean

initialize

  • initialize(): void

listenTo

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • 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 any

  • Parameters

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

    Returns any

projectToObject

  • Same as toObject but emits [[ Serializer#EVENT_BEGIN ]] and [[ Serializer#EVENT_END ]] events.

    Parameters

    • value: ProjectReflection
    • Optional eventData: object

      Partial information to set in the event

      • Optional begin?: any
      • Optional end?: any

    Returns any

removeAllComponents

  • removeAllComponents(): void

removeComponent

stopListening

toObject

  • toObject(value: any, obj?: any): any

trigger

  • 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 this

Generated using TypeDoc