Class Serializer

Serializes TypeDoc's models to JSON

Hierarchy (View Summary)

EventDispatcher<SerializerEvents>
- Serializer

Index

Constructors

constructor

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

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.

Methods

addSerializer

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

off

off<K extends keyof SerializerEvents>(
event: K,
listener: (this: undefined, ...args: SerializerEvents[K]) => void,
): 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.
Returns void
Inherited from EventDispatcher.off
- Defined in lib/utils-common/events.ts:42

on

on<K extends keyof SerializerEvents>(
    event: K,
    listener: (this: undefined, ...args: SerializerEvents[K]) => void,
    priority?: number,
): 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.
- priority: number = 0
  optional priority to insert this hook with. Higher priority is placed earlier in the listener array.
Returns void
Inherited from EventDispatcher.on
- Defined in lib/utils-common/events.ts:27

projectToObject

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

removeSerializer

removeSerializer(serializer: SerializerComponent<any>): void
Parameters
- serializer: SerializerComponent<any>
Returns void
- Defined in lib/serialization/serializer.ts:48

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>
- Defined in lib/serialization/serializer.ts:52
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>
- Defined in lib/serialization/serializer.ts:55

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>[]
- Defined in lib/serialization/serializer.ts:73

trigger

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

Properties

project

project: Models.ProjectReflection

Only set when serializing

projectRoot

projectRoot: NormalizedPath

Only set when serializing.

Class Serializer

Hierarchy (View Summary)

Index

Constructors

Events

Methods

Properties

Constructors

constructor

Returns Serializer

Events

Static ReadonlyEVENT_BEGIN

Static ReadonlyEVENT_END

Methods

addSerializer

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

projectToObject

Parameters

Returns JSONOutput.ProjectReflection

removeSerializer

Parameters

Returns void

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

Properties

project

projectRoot

Settings

On This Page

`Static` `Readonly`EVENT_BEGIN

`Static` `Readonly`EVENT_END