@remix-relay/react/dist/index.d.mts

Provides Relay integration with React Router (Framework)

import * as react_jsx_runtime from 'react/jsx-runtime';
import { SuspenseProps, PropsWithChildren } from 'react';
import relay, { GraphQLTaggedNode as GraphQLTaggedNode$1, PreloadFetchPolicy } from 'react-relay';
import * as relay_runtime from 'relay-runtime';
import { Environment, OperationType, GraphQLTaggedNode, VariablesOf, RequestParameters, Variables, CacheConfig, Observable } from 'relay-runtime';
import { MetaFunction } from 'react-router';

declare function Deferred({ children, ...rest }: SuspenseProps): react_jsx_runtime.JSX.Element;

declare function getClientLoaderQuery(environment: Environment): <TQuery extends OperationType>(query: GraphQLTaggedNode, variables: VariablesOf<TQuery>) => Promise<{
    queryRef: relay.PreloadedQuery<TQuery, {}>;
    data: Awaited<TQuery["response"]> | undefined;
}>;
declare function clientLoaderQuery<TQuery extends OperationType>(environment: Environment, query: GraphQLTaggedNode, variables: VariablesOf<TQuery>): Promise<{
    queryRef: relay.PreloadedQuery<TQuery, {}>;
    data: Awaited<TQuery["response"]> | undefined;
}>;

declare function RemixRelayProvider({ children }: PropsWithChildren): react_jsx_runtime.JSX.Element;

declare function getCachedResponse(params: RequestParameters, variables: Variables, cacheConfig: CacheConfig): Observable<unknown> | null;

declare function metaQuery<TQuery extends OperationType>(metaFunction: (args: Parameters<MetaFunction>[0] & {
    data: TQuery["response"];
}) => ReturnType<MetaFunction>): MetaFunction<() => {
    preloadedQuery: {
        response: {
            data: TQuery["response"];
        };
    };
} | {
    data: TQuery["response"];
}>;

declare function useLoaderQuery<TQuery extends OperationType>(query: GraphQLTaggedNode$1, fetchPolicy?: PreloadFetchPolicy): [TQuery["response"], (variables: relay.VariablesOf<TQuery>, options?: relay.UseQueryLoaderLoadQueryOptions) => void, relay_runtime.DisposeFn];
declare function useRouteLoaderQuery<TQuery extends OperationType>(routeId: string, query: GraphQLTaggedNode$1, fetchPolicy?: PreloadFetchPolicy): [TQuery["response"], (variables: relay.VariablesOf<TQuery>, options?: relay.UseQueryLoaderLoadQueryOptions) => void, relay_runtime.DisposeFn];

export { Deferred, RemixRelayProvider, clientLoaderQuery, getCachedResponse, getClientLoaderQuery, metaQuery, useLoaderQuery, useRouteLoaderQuery };