Class Serializer

Intentionally very simple event emitter.

Hierarchy (view full)

EventDispatcher<SerializerEvents>
- Serializer

Index

Constructors

constructor

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

Properties

projectRoot

projectRoot: string

Only set when serializing.

Methods

addSerializer

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

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:73

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:38
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:41

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:59

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" = "begin"

Triggered when the Serializer begins transforming a project.

`Static` `Readonly`EVENT_END

EVENT_END: "end" = "end"

Triggered when the Serializer has finished transforming a project.

Class Serializer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns Serializer

Properties

projectRoot

Methods

addSerializer

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Parameters

Returns void

Returns void

on

Type Parameters

Parameters

Parameters

Returns void

Returns void

projectToObject

Parameters

Returns JSONOutput.ProjectReflection

toObject

Type Parameters

Parameters

Returns ModelToObject<T>

Type Parameters

Parameters

Returns undefined | ModelToObject<T>

toObjectsOptional

Type Parameters

Parameters

Returns undefined | ModelToObject<T>[]

trigger

Type Parameters

Parameters

Returns void

Events

Static ReadonlyEVENT_BEGIN

Static ReadonlyEVENT_END

Settings

On This Page

`Static` `Readonly`EVENT_BEGIN

`Static` `Readonly`EVENT_END