Back to Apollo Client

Api Report Utilities.Api

.api-reports/api-report-utilities.api.md

3.14.18.4 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 { ASTNode } from 'graphql';
import { canonicalStringify } from '@apollo/client/utilities/internal';
import { DeepOmit } from '@apollo/client/utilities/internal';
import type { DocumentNode } from 'graphql';
import type { DocumentNode as DocumentNode_2 } from '@apollo/client';
import type { FieldNode } from 'graphql';
import type { FieldPolicy } from '@apollo/client/cache';
import type { FormattedExecutionResult } from 'graphql';
import { getMainDefinition } from '@apollo/client/utilities/internal';
import type { NetworkStatus } from '@apollo/client';
import { Observable } from 'rxjs';
import type { Primitive } from '@apollo/client/utilities/internal';
import type { Reference as Reference_2 } from '@apollo/client/cache';

// @public
export const addTypenameToDocument: (<TNode extends ASTNode>(doc: TNode) => TNode) & {
    added(field: FieldNode): boolean;
};

// @public
export type AsStoreObject<T extends {
    __typename?: string;
}> = {
    [K in keyof T]: T[K];
};

// @public
export interface CacheSizes {
    "cache.fragmentQueryDocuments": number;
    "documentTransform.cache": number;
    "fragmentRegistry.findFragmentSpreads": number;
    "fragmentRegistry.lookup": number;
    "fragmentRegistry.transform": number;
    "inMemoryCache.executeSelectionSet": number;
    "inMemoryCache.executeSubSelectedArray": number;
    "inMemoryCache.maybeBroadcastWatch": number;
    "PersistedQueryLink.persistedQueryHashes": number;
    "queryManager.getDocumentInfo": number;
    "removeTypenameFromVariables.getVariableDefinitions": number;
    canonicalStringify: number;
    checkDocument: number;
    print: number;
}

// @public
export const cacheSizes: Partial<CacheSizes>;

export { canonicalStringify }

// Warning: (ae-forgotten-export) The symbol "KeyArgs" needs to be exported by the entry point index.d.ts
//
// @public
export function concatPagination<T = Reference_2>(keyArgs?: KeyArgs): FieldPolicy<T[]>;

// Warning: (ae-forgotten-export) The symbol "DeepPartialPrimitive" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DeepPartialMap" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DeepPartialReadonlyMap" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DeepPartialSet" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DeepPartialReadonlySet" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "DeepPartialObject" needs to be exported by the entry point index.d.ts
//
// @public
export type DeepPartial<T> = T extends DeepPartialPrimitive ? T : T extends Map<infer TKey, infer TValue> ? DeepPartialMap<TKey, TValue> : T extends ReadonlyMap<infer TKey, infer TValue> ? DeepPartialReadonlyMap<TKey, TValue> : T extends Set<infer TItem> ? DeepPartialSet<TItem> : T extends ReadonlySet<infer TItem> ? DeepPartialReadonlySet<TItem> : T extends (...args: any[]) => unknown ? T | undefined : T extends object ? T extends (ReadonlyArray<infer TItem>) ? TItem[] extends (T) ? readonly TItem[] extends T ? ReadonlyArray<DeepPartial<TItem>> : Array<DeepPartial<TItem>> : DeepPartialObject<T> : DeepPartialObject<T> : unknown;

// @public (undocumented)
type DeepPartialMap<TKey, TValue> = {} & Map<DeepPartial<TKey>, DeepPartial<TValue>>;

// @public (undocumented)
type DeepPartialObject<T extends object> = {
    [K in keyof T]?: DeepPartial<T[K]>;
};

// @public (undocumented)
type DeepPartialPrimitive = Primitive | Date | RegExp;

// @public (undocumented)
type DeepPartialReadonlyMap<TKey, TValue> = {} & ReadonlyMap<DeepPartial<TKey>, DeepPartial<TValue>>;

// @public (undocumented)
type DeepPartialReadonlySet<T> = {} & ReadonlySet<DeepPartial<T>>;

// @public (undocumented)
type DeepPartialSet<T> = {} & Set<DeepPartial<T>>;

// @public
export class DocumentTransform {
    // Warning: (ae-forgotten-export) The symbol "TransformFn" needs to be exported by the entry point index.d.ts
    // Warning: (ae-forgotten-export) The symbol "DocumentTransformOptions" needs to be exported by the entry point index.d.ts
    constructor(transform: TransformFn, options?: DocumentTransformOptions);
    concat(otherTransform: DocumentTransform): DocumentTransform;
    static identity(): DocumentTransform;
    // @internal @deprecated
    readonly left?: DocumentTransform;
    resetCache(): void;
    // @internal @deprecated
    readonly right?: DocumentTransform;
    static split(predicate: (document: DocumentNode) => boolean, left: DocumentTransform, right?: DocumentTransform): DocumentTransform & {
        left: DocumentTransform;
        right: DocumentTransform;
    };
    transformDocument(document: DocumentNode): DocumentNode;
}

// @public (undocumented)
export type DocumentTransformCacheKey = ReadonlyArray<unknown>;

// @public (undocumented)
interface DocumentTransformOptions {
    cache?: boolean;
    getCacheKey?: (document: DocumentNode) => DocumentTransformCacheKey | undefined;
}

export { getMainDefinition }

// @beta
export interface HKT {
    // (undocumented)
    arg1: unknown;
    // (undocumented)
    arg2: unknown;
    // (undocumented)
    arg3: unknown;
    // (undocumented)
    arg4: unknown;
    // (undocumented)
    return: unknown;
}

// @public
export function isFormattedExecutionResult(result?: object): result is FormattedExecutionResult;

// @public
export function isMutationOperation(document: DocumentNode_2): boolean;

// @public
export function isNetworkRequestInFlight(networkStatus?: NetworkStatus): boolean;

// @public
export function isNetworkRequestSettled(networkStatus?: NetworkStatus): boolean;

// @public
export function isQueryOperation(document: DocumentNode_2): boolean;

// @public
export function isReference(obj: any): obj is Reference;

// @public
export function isSubscriptionOperation(document: DocumentNode_2): boolean;

// @public (undocumented)
type KeyArgs = FieldPolicy<any>["keyArgs"];

export { Observable }

// @public
export function offsetLimitPagination<T = Reference_2>(keyArgs?: KeyArgs): FieldPolicy<T[]>;

// @public
const print_2: ((ast: ASTNode) => string) & {
    reset(): void;
};
export { print_2 as print }

// @public
export interface Reference {
    // (undocumented)
    readonly __ref: string;
}

// Warning: (ae-forgotten-export) The symbol "TExistingRelay" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "TIncomingRelay" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
type RelayFieldPolicy<TNode> = FieldPolicy<TExistingRelay<TNode> | null, TIncomingRelay<TNode> | null, TIncomingRelay<TNode> | null>;

// Warning: (ae-forgotten-export) The symbol "RelayFieldPolicy" needs to be exported by the entry point index.d.ts
//
// @public
export function relayStylePagination<TNode extends Reference_2 = Reference_2>(keyArgs?: KeyArgs): RelayFieldPolicy<TNode>;

// @public
export interface StoreObject {
    // (undocumented)
    [storeFieldName: string]: StoreValue;
    // (undocumented)
    __typename?: string;
}

// @public
export type StoreValue = number | string | string[] | Reference | Reference[] | null | undefined | void | Object;

// @public
export function stripTypename<T>(value: T): DeepOmit<T, "__typename">;

// @public (undocumented)
type TExistingRelay<TNode> = Readonly<{
    edges: TRelayEdge<TNode>[];
    pageInfo: TRelayPageInfo;
}>;

// @public (undocumented)
type TIncomingRelay<TNode> = {
    edges?: TRelayEdge<TNode>[];
    pageInfo?: TRelayPageInfo;
};

// @public (undocumented)
type TransformFn = (document: DocumentNode) => DocumentNode;

// @public (undocumented)
type TRelayEdge<TNode> = {
    cursor?: string;
    node: TNode;
} | (Reference_2 & {
    cursor?: string;
});

// @public (undocumented)
type TRelayPageInfo = {
    hasPreviousPage: boolean;
    hasNextPage: boolean;
    startCursor: string;
    endCursor: string;
};

// Warnings were encountered during analysis:
//
// src/utilities/policies/pagination.ts:86:3 - (ae-forgotten-export) The symbol "TRelayEdge" needs to be exported by the entry point index.d.ts
// src/utilities/policies/pagination.ts:87:3 - (ae-forgotten-export) The symbol "TRelayPageInfo" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)