graphql/jsutils/Path.d.ts

A Query Language and Runtime which can target any service.

/** @category Paths */
import type { Maybe } from "./Maybe.js";
/** Represents a linked response path from a field back to the root response. */
export interface Path {
    /** The previous segment in the linked response path, or undefined at the root. */
    readonly prev: Path | undefined;
    /** The field name or list index for this response path segment. */
    readonly key: string | number;
    /** The runtime object type name associated with this path segment, if known. */
    readonly typename: string | undefined;
}
/**
 * Given a Path and a key, return a new Path containing the new key.
 *
 * @internal
 */
export declare function addPath(prev: Readonly<Path> | undefined, key: string | number, typename: string | undefined): Path;
/**
 * Given a Path, return an Array of the path keys.
 * @param path - The linked response path to flatten.
 * @returns An array of response path keys from root to leaf.
 * @example
 * ```ts
 * import { pathToArray } from 'graphql/jsutils/Path';
 *
 * const path = {
 *   prev: {
 *     prev: {
 *       prev: undefined,
 *       key: 'viewer',
 *       typename: 'Query',
 *     },
 *     key: 'friends',
 *     typename: 'User',
 *   },
 *   key: 0,
 *   typename: undefined,
 * };
 *
 * pathToArray(path); // => ['viewer', 'friends', 0]
 * pathToArray(undefined); // => []
 * ```
 */
export declare function pathToArray(path: Maybe<Readonly<Path>>): Array<string | number>;