generate-index-metafile

Generate index metafile event class.

Events

GenerateIndexMetafileEvent

Defined in: core/src/events/generate-index-metafile.ts:15

Event emitted before/after generating index metafile.

Extends

• DataEvent<{ category: string; dirPath: string; options?: Record<string, unknown>; }>

Constructors

Constructor

new GenerateIndexMetafileEvent(data, options?): GenerateIndexMetafileEvent;

Defined in: core/src/events/generate-index-metafile.ts:20

Parameters

data

category

string

dirPath

string

options?

Record<string, unknown>

options?

CancellableEventOptions

Returns

GenerateIndexMetafileEvent

Overrides

DataEvent.constructor

Properties

data

readonly data: object;

Defined in: utils/dist/events.d.ts:111

Read-only event data payload.

category

category: string;

dirPath

dirPath: string;

options?

optional options?: Record<string, unknown>;

Inherited from

DataEvent.data

Accessors

defaultAction

Get Signature

get defaultAction(): DefaultAction | undefined;

Defined in: utils/dist/events.d.ts:78

Gets the default action function if one was provided.

Returns

DefaultAction | undefined

Inherited from

DataEvent.defaultAction

defaultPrevented

Get Signature

get defaultPrevented(): boolean;

Defined in: utils/dist/events.d.ts:70

Gets whether the default action has been prevented.

Returns

boolean

Set Signature

set defaultPrevented(value): void;

Defined in: utils/dist/events.d.ts:82

Allows setting defaultPrevented to true directly.

Parameters

value

boolean

Returns

void

Inherited from

DataEvent.defaultPrevented

propagationStopped

Get Signature

get propagationStopped(): boolean;

Defined in: utils/dist/events.d.ts:74

Gets whether propagation has been stopped.

Returns

boolean

Set Signature

set propagationStopped(value): void;

Defined in: utils/dist/events.d.ts:86

Allows setting propagationStopped to true directly.

Parameters

value

boolean

Returns

void

Inherited from

DataEvent.propagationStopped

Methods

preventDefault()

preventDefault(): void;

Defined in: utils/dist/events.d.ts:91

Prevents the default action from executing. Only works if the event is cancellable.

Returns

void

Inherited from

DataEvent.preventDefault

runDefaultAction()

runDefaultAction(): Promise<void>;

Defined in: utils/dist/events.d.ts:100

Executes the default action for an event if it hasn't been prevented.

Returns

Promise<void>

Inherited from

DataEvent.runDefaultAction

stopPropagation()

stopPropagation(): void;

Defined in: utils/dist/events.d.ts:96

Stops propagation to remaining event handlers. Handlers registered after the current one will not execute.

Returns

void

Inherited from

DataEvent.stopPropagation