events
Base event class and utilities for GraphQL-Markdown events.
Events
abstract CancellableEvent
Defined in: events.ts:55
Base class for all cancellable events in GraphQL-Markdown.
Provides common functionality:
- preventDefault() to cancel default actions
- stopPropagation() to halt handler chain
- Configurable cancellability
- Optional default action function
Extended by
Implements
ICancellableEvent
Constructors
Constructor
new CancellableEvent(options?): CancellableEvent;
Defined in: events.ts:88
Creates a new CancellableEvent.
Parameters
options?
Configuration options for the event
Returns
Remarks
options.cancellable controls whether this event can be cancelled (default: true). options.defaultAction defines an optional function to execute as default action.
Accessors
defaultAction
Get Signature
get defaultAction(): DefaultAction | undefined;
Defined in: events.ts:110
Gets the default action function if one was provided.
Returns
DefaultAction | undefined
Implementation of
ICancellableEvent.defaultAction;
defaultPrevented
Get Signature
get defaultPrevented(): boolean;
Defined in: events.ts:96
Gets whether the default action has been prevented.
Returns
boolean
Set Signature
set defaultPrevented(value): void;
Defined in: events.ts:117
Allows setting defaultPrevented to true directly.
Parameters
value
boolean
Returns
void
Implementation of
ICancellableEvent.defaultPrevented;
propagationStopped
Get Signature
get propagationStopped(): boolean;
Defined in: events.ts:103
Gets whether propagation has been stopped.
Returns
boolean
Set Signature
set propagationStopped(value): void;
Defined in: events.ts:126
Allows setting propagationStopped to true directly.
Parameters
value
boolean
Returns
void
Implementation of
ICancellableEvent.propagationStopped;
Methods
preventDefault()
preventDefault(): void;
Defined in: events.ts:136
Prevents the default action from executing. Only works if the event is cancellable.
Returns
void
Implementation of
ICancellableEvent.preventDefault;
runDefaultAction()
runDefaultAction(): Promise<void>;
Defined in: events.ts:153
Executes the default action for an event if it hasn't been prevented.
Returns
Promise<void>
Implementation of
ICancellableEvent.runDefaultAction;
stopPropagation()
stopPropagation(): void;
Defined in: events.ts:146
Stops propagation to remaining event handlers. Handlers registered after the current one will not execute.
Returns
void
Implementation of
ICancellableEvent.stopPropagation;
abstract DataEvent
Defined in: events.ts:168
Abstract base for events that carry a typed, read-only data payload.
Extends
Extended by
DataOutputEventDiffCheckEventGenerateIndexMetafileEventRenderHomepageEventRenderRootTypesEventRenderTypeEntitiesEventSchemaEvent
Type Parameters
TData
TData
Type of the event data payload.
Constructors
Constructor
new DataEvent<TData>(data, options?): DataEvent<TData>;
Defined in: events.ts:172
Parameters
data
TData
options?
Returns
DataEvent<TData>
Overrides
Properties
data
readonly data: TData;
Defined in: events.ts:170
Read-only event data payload.
Accessors
defaultAction
Get Signature
get defaultAction(): DefaultAction | undefined;
Defined in: events.ts:110
Gets the default action function if one was provided.
Returns
DefaultAction | undefined
Inherited from
CancellableEvent.defaultAction
defaultPrevented
Get Signature
get defaultPrevented(): boolean;
Defined in: events.ts:96
Gets whether the default action has been prevented.
Returns
boolean
Set Signature
set defaultPrevented(value): void;
Defined in: events.ts:117
Allows setting defaultPrevented to true directly.
Parameters
value
boolean
Returns
void
Inherited from
CancellableEvent.defaultPrevented
propagationStopped
Get Signature
get propagationStopped(): boolean;
Defined in: events.ts:103
Gets whether propagation has been stopped.
Returns
boolean
Set Signature
set propagationStopped(value): void;
Defined in: events.ts:126
Allows setting propagationStopped to true directly.
Parameters
value
boolean
Returns
void
Inherited from
CancellableEvent.propagationStopped
Methods
preventDefault()
preventDefault(): void;
Defined in: events.ts:136
Prevents the default action from executing. Only works if the event is cancellable.
Returns
void
Inherited from
CancellableEvent.preventDefault
runDefaultAction()
runDefaultAction(): Promise<void>;
Defined in: events.ts:153
Executes the default action for an event if it hasn't been prevented.
Returns
Promise<void>
Inherited from
CancellableEvent.runDefaultAction
stopPropagation()
stopPropagation(): void;
Defined in: events.ts:146
Stops propagation to remaining event handlers. Handlers registered after the current one will not execute.
Returns
void
Inherited from
CancellableEvent.stopPropagation
abstract DataOutputEvent
Defined in: events.ts:186
Abstract base for events that carry typed data and a mutable output value.
Extends
DataEvent<TData>
Extended by
Type Parameters
TData
TData
Type of the event data payload.
TOutput
TOutput
Type of the mutable output value.
Constructors
Constructor
new DataOutputEvent<TData, TOutput>(
data,
initialOutput,
options?): DataOutputEvent<TData, TOutput>;
Defined in: events.ts:193
Parameters
data
TData
initialOutput
TOutput
options?
Returns
DataOutputEvent<TData, TOutput>
Overrides
Properties
data
readonly data: TData;
Defined in: events.ts:170
Read-only event data payload.
Inherited from
output
output: TOutput;
Defined in: events.ts:191
The generated output. Handlers can modify this property to change the final result.
Accessors
defaultAction
Get Signature
get defaultAction(): DefaultAction | undefined;
Defined in: events.ts:110
Gets the default action function if one was provided.
Returns
DefaultAction | undefined
Inherited from
defaultPrevented
Get Signature
get defaultPrevented(): boolean;
Defined in: events.ts:96
Gets whether the default action has been prevented.
Returns
boolean
Set Signature
set defaultPrevented(value): void;
Defined in: events.ts:117
Allows setting defaultPrevented to true directly.
Parameters
value
boolean
Returns
void
Inherited from
propagationStopped
Get Signature
get propagationStopped(): boolean;
Defined in: events.ts:103
Gets whether propagation has been stopped.
Returns
boolean
Set Signature
set propagationStopped(value): void;
Defined in: events.ts:126
Allows setting propagationStopped to true directly.
Parameters
value
boolean
Returns
void
Inherited from
Methods
preventDefault()
preventDefault(): void;
Defined in: events.ts:136
Prevents the default action from executing. Only works if the event is cancellable.
Returns
void
Inherited from
runDefaultAction()
runDefaultAction(): Promise<void>;
Defined in: events.ts:153
Executes the default action for an event if it hasn't been prevented.
Returns
Promise<void>
Inherited from
stopPropagation()
stopPropagation(): void;
Defined in: events.ts:146
Stops propagation to remaining event handlers. Handlers registered after the current one will not execute.
Returns
void
Inherited from
Other
CancellableEventOptions
Defined in: events.ts:39
Properties
cancellable?
optional cancellable?: boolean;
Defined in: events.ts:41
defaultAction?
optional defaultAction?: DefaultAction;
Defined in: events.ts:40
deepFreeze()
function deepFreeze<T>(obj): T;
Defined in: events.ts:23
Deep freezes an object to make it immutable at runtime. Recursively freezes all nested objects and arrays.
Type Parameters
T
T extends Record<PropertyKey, any>
Parameters
obj
T
The object to freeze
Returns
T
The frozen object (same reference)
Example
const data = { user: { name: "John" } };
deepFreeze(data);
data.user.name = "Jane"; // Throws error in strict mode