Back to Apollo Client

Api Report React Ssr.Api

.api-reports/api-report-react_ssr.api.md

3.14.13.0 KB
Original Source

API Report File for "@apollo/client"

Do not edit this file. It is a report generated by API Extractor.

ts

import type { ApolloClient } from '@apollo/client';
import type * as ReactTypes from 'react';

// @public @deprecated (undocumented)
export function getDataFromTree(tree: ReactTypes.ReactNode, context?: {
    [key: string]: any;
}): Promise<string>;

// Warning: (ae-forgotten-export) The symbol "GetMarkupFromTreeOptions" needs to be exported by the entry point index.d.ts
//
// @public @deprecated (undocumented)
export function getMarkupFromTree({ tree, context, renderFunction, }: GetMarkupFromTreeOptions): Promise<string>;

// @public (undocumented)
type GetMarkupFromTreeOptions = {
    tree: ReactTypes.ReactNode;
    context?: {
        [key: string]: any;
    };
    renderFunction?: prerenderStatic.RenderToString | prerenderStatic.RenderToStringPromise;
};

// @public
export function prerenderStatic<Prerender extends prerenderStatic.PrerenderFunction = prerenderStatic.PrerenderFunction>({ tree, context, renderFunction, signal, ignoreResults, diagnostics, maxRerenders, }: prerenderStatic.Options<Prerender>): Promise<prerenderStatic.Result<Prerender>>;

// @public (undocumented)
export namespace prerenderStatic {
    // (undocumented)
    export interface Diagnostics {
        renderCount: number;
    }
    // (undocumented)
    export interface Options<Prerender extends PrerenderFunction = PrerenderFunction> {
        context?: {
            client?: ApolloClient;
        };
        diagnostics?: boolean;
        ignoreResults?: boolean;
        maxRerenders?: number;
        renderFunction: Prerender;
        signal?: AbortSignal;
        tree: ReactTypes.ReactNode;
    }
    export type PrerenderFunction = RenderToString | RenderToStringPromise | PrerenderToWebStream | PrerenderToNodeStream | ((reactNode: ReactTypes.ReactNode) => ReturnType<RenderToString> | ReturnType<RenderToStringPromise> | ReturnType<PrerenderToWebStream> | ReturnType<PrerenderToNodeStream>);
    // (undocumented)
    export type PrerenderToNodeStream = (reactNode: ReactTypes.ReactNode) => Promise<{
        prelude: AsyncIterable<string | Buffer>;
    }>;
    // (undocumented)
    export type PrerenderToWebStream = (reactNode: ReactTypes.ReactNode) => Promise<{
        prelude: ReadableStream<Uint8Array>;
    }>;
    // (undocumented)
    export type RenderToString = (element: ReactTypes.ReactNode) => string;
    // (undocumented)
    export type RenderToStringPromise = (element: ReactTypes.ReactNode) => PromiseLike<string>;
    // (undocumented)
    export interface Result<Prerender extends PrerenderFunction = PrerenderFunction> {
        aborted: boolean;
        diagnostics?: Diagnostics;
        renderFnResult: ReturnType<Prerender> extends PromiseLike<infer U> ? U : ReturnType<Prerender>;
        result: string;
    }
}

// @public @deprecated (undocumented)
export function renderToStringWithData(component: ReactTypes.ReactElement<any>): Promise<string>;

// (No @packageDocumentation comment for this package)