schema-load
Schema loading event class.
Events
SchemaEvent
Defined in: core/src/events/schema-load.ts:16
Event emitted before/after loading a GraphQL schema.
Extends
DataEvent<{rootTypes?:Maybe<SchemaMap>;schema?:Maybe<GraphQLSchema>;schemaLocation?:string; }>
Constructors
Constructor
new SchemaEvent(data, options?): SchemaEvent;
Defined in: core/src/events/schema-load.ts:21
Parameters
data
rootTypes?
Maybe<SchemaMap>
schema?
Maybe<GraphQLSchema>
schemaLocation?
string
options?
Returns
Overrides
Properties
data
readonly data: object;
Defined in: utils/dist/events.d.ts:111
Read-only event data payload.
rootTypes?
optional rootTypes?: Maybe<SchemaMap>;
schema?
optional schema?: Maybe<GraphQLSchema>;
schemaLocation?
optional schemaLocation?: string;
Inherited from
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
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
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
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
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
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