Class Serializer

Intentionally very simple event emitter.

Hierarchy (view full)

EventDispatcher<SerializerEvents>
- Serializer

Index

Constructors

Properties

project projectRoot

Methods

addSerializer off on projectToObject toObject toObjectsOptional trigger

Events

EVENT_BEGIN EVENT_END

Constructors

constructor

new Serializer(): Serializer
Returns Serializer
Inherited from EventDispatcher.constructor

Properties

project

project: Models.ProjectReflection

Only set when serializing

projectRoot

projectRoot: string

Only set when serializing.

Methods

addSerializer

addSerializer<T>(serializer): void
Type Parameters
- T extends object
Parameters
- serializer: SerializerComponent<T>
Returns void
- Defined in serialization/serializer.ts:39

off

off<K>(event, listener): void
Stops listening to an event.
Type Parameters
- K extends keyof SerializerEvents
Parameters
- event: K
  the event to stop listening to.
- listener: ((this: undefined, ...args: SerializerEvents[K]) => void)
  the function to remove from the listener array.
  - - (this, ...args): void
    - Parameters
      this: undefined
      Rest...args: SerializerEvents[K]
      Returns void
Returns void
Inherited from EventDispatcher.off
- Defined in utils/events.ts:41

on

on<K>(event, listener, priority?): void
Starts listening to an event.
Type Parameters
- K extends keyof SerializerEvents
Parameters
- event: K
  the event to listen to.
- listener: ((this: undefined, ...args: SerializerEvents[K]) => void)
  function to be called when an this event is emitted.
  - - (this, ...args): void
    - Parameters
      this: undefined
      Rest...args: SerializerEvents[K]
      Returns void
- priority: number = 0
  optional priority to insert this hook with.
Returns void
Inherited from EventDispatcher.on
- Defined in utils/events.ts:26

projectToObject

projectToObject(value, projectRoot): JSONOutput.ProjectReflection
Same as toObject but emits Serializer.EVENT_BEGIN and Serializer.EVENT_END events.
Parameters
- value: Models.ProjectReflection
- projectRoot: string
Returns JSONOutput.ProjectReflection
- Defined in serialization/serializer.ts:78

toObject

toObject<T>(value): ModelToObject<T>
Type Parameters
- T extends {
  toObject(serializer: Serializer): ModelToObject<T>;
  }
Parameters
- value: T
Returns ModelToObject<T>
- Defined in serialization/serializer.ts:43
toObject<T>(value): undefined | ModelToObject<T>
Type Parameters
- T extends {
  toObject(serializer: Serializer): ModelToObject<T>;
  }
Parameters
- value: undefined | T
Returns undefined | ModelToObject<T>
- Defined in serialization/serializer.ts:46

toObjectsOptional

toObjectsOptional<T>(value): undefined | ModelToObject<T>[]
Type Parameters
- T extends {
  toObject(serializer: Serializer): ModelToObject<T>;
  }
Parameters
- value: undefined | T[]
Returns undefined | ModelToObject<T>[]
- Defined in serialization/serializer.ts:64

trigger

trigger<K>(event, ...args): void
Emits an event to all currently subscribed listeners.
Type Parameters
- K extends keyof SerializerEvents
Parameters
- event: K
  the event to emit.
- Rest...args: SerializerEvents[K]
  any arguments required for the event.
Returns void
Inherited from EventDispatcher.trigger
- Defined in utils/events.ts:59

Events

`Static` `Readonly`EVENT_BEGIN

EVENT_BEGIN = "begin"

Triggered when the Serializer begins transforming a project.

`Static` `Readonly`EVENT_END

EVENT_END = "end"

Triggered when the Serializer has finished transforming a project.