relay-runtime/handlers/connection/ConnectionInterface.d.ts

A core runtime for building GraphQL-driven applications.

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

import { DataID } from '../../util/RelayRuntimeTypes';

export interface EdgeRecord extends Record<string, unknown> {
    cursor: unknown;
    node: Record<DataID, unknown>;
}

export interface PageInfo {
    endCursor: string | null | undefined;
    hasNextPage: boolean;
    hasPreviousPage: boolean;
    startCursor: string | null | undefined;
}

interface ConnectionConfig {
    CURSOR: string;
    EDGES: string;
    END_CURSOR: string;
    HAS_NEXT_PAGE: string;
    HAS_PREV_PAGE: string;
    NODE: string;
    PAGE_INFO: string;
    PAGE_INFO_TYPE: string;
    START_CURSOR: string;
}

declare const ConnectionInterface: {
    get(): ConnectionConfig;

    inject(newConfig: ConnectionConfig): void;
};

export default ConnectionInterface;