next-with-apollo/lib/types.d.ts

Apollo HOC for Next.js

/// <reference types="node" />
import ApolloClient from 'apollo-client';
import { IncomingHttpHeaders } from 'http';
import { NextPage, NextPageContext } from 'next';
import { AppContext } from 'next/app';
import { NextRouter } from 'next/dist/client/router';
import { ReactNode } from 'react';
export interface WithApolloOptions {
    getDataFromTree?: (tree: ReactNode, context?: {
        [key: string]: any;
    }) => Promise<any>;
    render?: (props: {
        Page: NextPage<any>;
        props: any;
    }) => any;
    onError?: (error: Error, ctx?: NextPageContext) => void;
}
export interface WithApolloState<TCache> {
    data?: TCache;
}
export interface WithApolloProps<TCache> {
    apolloState: WithApolloState<TCache>;
    apollo: ApolloClient<TCache>;
    router: NextRouter;
}
export interface InitApolloOptions<TCache> {
    ctx?: NextPageContext;
    headers?: IncomingHttpHeaders;
    router?: NextRouter;
    initialState?: TCache;
}
export declare type InitApolloClient<TCache> = (options: InitApolloOptions<TCache>) => ApolloClient<TCache>;
export interface ApolloPageContext<C = any> extends NextPageContext {
    apolloClient: ApolloClient<C>;
}
export interface ApolloAppContext<C = any> extends AppContext {
    ctx: ApolloPageContext<C>;
    AppTree: any;
}
export declare type ApolloContext<C = any> = ApolloPageContext<C> | ApolloAppContext<C>;