graphql/execution/AbortedGraphQLExecutionError.d.mts

A Query Language and Runtime which can target any service.

/** @category Execution */
import type { PromiseOrValue } from "../jsutils/PromiseOrValue.mjs";
/**
 * Error thrown when GraphQL execution is aborted.
 * @typeParam TResult - Result value type.
 */
export declare class AbortedGraphQLExecutionError<TResult> extends Error {
    /** Partial execution result available when execution was aborted. */
    readonly abortedResult: PromiseOrValue<TResult>;
    /**
     * Creates an error for an aborted GraphQL execution.
     * @param reason - Abort reason used as the error cause.
     * @param result - Partial execution result available when execution stopped.
     * @example
     * ```ts
     * import { AbortedGraphQLExecutionError } from 'graphql/execution';
     *
     * const cause = new Error('Request cancelled.');
     * const partialResult = { data: { viewer: null } };
     * const error = new AbortedGraphQLExecutionError(cause, partialResult);
     *
     * error.message; // => 'Request cancelled.'
     * error.cause; // => cause
     * error.abortedResult; // => partialResult
     * ```
     */
    constructor(reason: unknown, result: PromiseOrValue<TResult>);
    /**
     * Returns the value used by `Object.prototype.toString`.
     * @returns The built-in string tag for this object.
     */
    get [Symbol.toStringTag](): string;
}