Prometheus Entity Management API
    Preparing search index...

    Interface GQLListOptions<TData, TEntity>

    interface GQLListOptions<TData, TEntity extends object> {
        client: GQLClient;
        descriptor: EntityDescriptor<unknown, TEntity>;
        document: string;
        enabled?: boolean;
        getItems: (data: TData) => unknown[];
        getPagination?: (
            data: TData,
        ) => {
            hasNextPage?: boolean;
            nextCursor?: string;
            page?: number;
            pageSize?: number;
            total?: number;
        };
        mode?: "replace"
        | "append";
        queryKey: unknown[];
        sideDescriptors?: EntityDescriptor<unknown, Record<string, unknown>>[];
        staleTime?: number;
        type: string;
        variables?: Record<string, unknown>;
    }

    Type Parameters

    • TData
    • TEntity extends object
    Index
    client: GQLClient
    descriptor: EntityDescriptor<unknown, TEntity>
    document: string
    enabled?: boolean
    getItems: (data: TData) => unknown[]
    getPagination?: (
        data: TData,
    ) => {
        hasNextPage?: boolean;
        nextCursor?: string;
        page?: number;
        pageSize?: number;
        total?: number;
    }
    mode?: "replace" | "append"
    queryKey: unknown[]
    sideDescriptors?: EntityDescriptor<unknown, Record<string, unknown>>[]
    staleTime?: number
    type: string
    variables?: Record<string, unknown>