ReferenceAPI referenceInterfaces
QueryAbortSignal
Generated API reference for QueryAbortSignal in @kysoql/core.
@kysoql/core / QueryAbortSignal
Minimal structural contract used for query cancellation.
Native AbortSignal instances satisfy this interface without requiring
@kysoql/core to depend on DOM or Node ambient types.
Methods
throwIfAborted()
throwIfAborted(): void;Throws the signal reason when cancellation has already been requested.
Returns
void
addEventListener()
addEventListener(
type,
listener,
options?
): void;Registers an abort listener using the AbortSignal-compatible contract.
Parameters
| Parameter | Type | Description |
|---|---|---|
type | "abort" | - |
listener | () => void | - |
options? | { once?: boolean; } | - |
options.once? | boolean | Remove the listener automatically after the first abort event. |
Returns
void
removeEventListener()
removeEventListener(type, listener): void;Removes a previously registered abort listener.
Parameters
| Parameter | Type |
|---|---|
type | "abort" |
listener | () => void |
Returns
void