Class SerializeEvent

An event emitted by the Serializer class at the very beginning and ending of the a project serialization process.

See

Hierarchy

Event
- SerializeEvent

Index

Constructors

Properties

output project outputDirectory? outputFile?

Accessors

isDefaultPrevented isPropagationStopped name

Methods

preventDefault stopPropagation

Constructors

constructor

new SerializeEvent(name: string, project: ProjectReflection, output?: JSONOutput.ProjectReflection): SerializeEvent
Parameters
- name: string
- project: ProjectReflection
- Optional output: JSONOutput.ProjectReflection
Returns SerializeEvent
Overrides Event.constructor
- Defined in src/lib/serialization/events.ts:38

Properties

output

output: undefined | JSONOutput.ProjectReflection

`Readonly` project

project: ProjectReflection

The project the renderer is currently processing.

`Optional` outputDirectory

outputDirectory?: string

The path of the directory the serialized JSON should be written to.

`Optional` outputFile

outputFile?: string

The name of the main JSON file (base + ext)

Accessors

isDefaultPrevented

get isDefaultPrevented(): boolean
Has preventDefault been called?

Returns boolean
Inherited from Event.isDefaultPrevented
- Defined in src/lib/utils/events.ts:390

isPropagationStopped

get isPropagationStopped(): boolean
Has stopPropagation been called?

Returns boolean
Inherited from Event.isPropagationStopped
- Defined in src/lib/utils/events.ts:383

name

get name(): string
Return the event name.

Returns string
Inherited from Event.name
- Defined in src/lib/utils/events.ts:376

Methods

preventDefault

preventDefault(): void
Prevent the default action associated with this event from being executed.

Returns void
Inherited from Event.preventDefault
- Defined in src/lib/utils/events.ts:369

stopPropagation

stopPropagation(): void
Stop the propagation of this event. Remaining event handlers will not be executed.

Returns void
Inherited from Event.stopPropagation
- Defined in src/lib/utils/events.ts:362

Generated using TypeDoc