Class Serializer

constructor

• new Serializer(): Serializer

  Returns Serializer

Static ReadonlyEVENT_BEGIN

Static ReadonlyEVENT_END

addSerializer

• addSerializer<T extends object>(serializer: SerializerComponent<T>): void

  Type Parameters

  • T extends object

  Parameters

  • serializer: SerializerComponent<T>

  Returns void

projectToObject

• projectToObject(
      value: Models.ProjectReflection,
      projectRoot: string,
  ): JSONOutput.ProjectReflection

  Same as toObject but emits Serializer.EVENT_BEGIN and Serializer.EVENT_END events.

  Parameters

  • value: Models.ProjectReflection
  • projectRoot: string

  Returns JSONOutput.ProjectReflection

removeSerializer

• removeSerializer(serializer: SerializerComponent<any>): void

  Parameters

  • serializer: SerializerComponent<any>

  Returns void

toObject

• toObject<T extends { toObject(serializer: Serializer): ModelToObject<T> }>(
      value: T,
  ): ModelToObject<T>

  Type Parameters

  • T extends { toObject(serializer: Serializer): ModelToObject<T> }

  Parameters

  • value: T

  Returns ModelToObject<T>

• toObject<T extends { toObject(serializer: Serializer): ModelToObject<T> }>(
      value: undefined | T,
  ): undefined | ModelToObject<T>

  Type Parameters

  • T extends { toObject(serializer: Serializer): ModelToObject<T> }

  Parameters

  • value: undefined | T

  Returns undefined | ModelToObject<T>

toObjectsOptional

• toObjectsOptional<
      T extends { toObject(serializer: Serializer): ModelToObject<T> },
  >(
      value: undefined | T[],
  ): undefined | ModelToObject<T>[]

  Type Parameters

  • T extends { toObject(serializer: Serializer): ModelToObject<T> }

  Parameters

  • value: undefined | T[]

  Returns undefined | ModelToObject<T>[]

project

projectRoot