angular-query-experimental.api.md

API Report File for "@tanstack/angular-query-experimental"

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

import type { DataTag } from '@tanstack/query-core'
import { DefaultError } from '@tanstack/query-core'
import type { DefinedInfiniteQueryObserverResult } from '@tanstack/query-core'
import type { DefinedQueryObserverResult } from '@tanstack/query-core'
import type { EnvironmentProviders } from '@angular/core'
import type { InfiniteData } from '@tanstack/query-core'
import type { InfiniteQueryObserverOptions } from '@tanstack/query-core'
import type { InfiniteQueryObserverResult } from '@tanstack/query-core'
import { InjectOptions } from '@angular/core'
import { Injector } from '@angular/core'
import type { MutateFunction } from '@tanstack/query-core'
import { Mutation } from '@tanstack/query-core'
import { MutationFilters } from '@tanstack/query-core'
import type { MutationObserverOptions } from '@tanstack/query-core'
import type { MutationObserverResult } from '@tanstack/query-core'
import { MutationState } from '@tanstack/query-core'
import type { OmitKeyof } from '@tanstack/query-core'
import { Provider } from '@angular/core'
import type { QueriesPlaceholderDataFunction } from '@tanstack/query-core'
import type { QueryClient } from '@tanstack/query-core'
import { QueryFilters } from '@tanstack/query-core'
import type { QueryFunction } from '@tanstack/query-core'
import type { QueryKey } from '@tanstack/query-core'
import type { QueryObserverOptions } from '@tanstack/query-core'
import type { QueryObserverResult } from '@tanstack/query-core'
import type { Signal } from '@angular/core'
import type { SkipToken } from '@tanstack/query-core'
import type { ThrowOnError } from '@tanstack/query-core'

// @public (undocumented)
export interface BaseMutationNarrowing<
  TData = unknown,
  TError = DefaultError,
  TVariables = unknown,
  TContext = unknown,
> {
  // (undocumented)
  isError: (
    this: CreateMutationResult<TData, TError, TVariables, TContext>,
  ) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TContext,
    CreateStatusBasedMutationResult<
      'error',
      TData,
      TError,
      TVariables,
      TContext
    >
  >
  // (undocumented)
  isIdle: (
    this: CreateMutationResult<TData, TError, TVariables, TContext>,
  ) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TContext,
    CreateStatusBasedMutationResult<'idle', TData, TError, TVariables, TContext>
  >
  // (undocumented)
  isPending: (
    this: CreateMutationResult<TData, TError, TVariables, TContext>,
  ) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TContext,
    CreateStatusBasedMutationResult<
      'pending',
      TData,
      TError,
      TVariables,
      TContext
    >
  >
  // Warning: (ae-forgotten-export) The symbol "CreateStatusBasedMutationResult" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  isSuccess: (
    this: CreateMutationResult<TData, TError, TVariables, TContext>,
  ) => this is CreateMutationResult<
    TData,
    TError,
    TVariables,
    TContext,
    CreateStatusBasedMutationResult<
      'success',
      TData,
      TError,
      TVariables,
      TContext
    >
  >
}

// @public (undocumented)
export interface BaseQueryNarrowing<TData = unknown, TError = DefaultError> {
  // (undocumented)
  isError: (
    this: CreateBaseQueryResult<TData, TError>,
  ) => this is CreateBaseQueryResult<
    TData,
    TError,
    CreateStatusBasedQueryResult<'error', TData, TError>
  >
  // (undocumented)
  isPending: (
    this: CreateBaseQueryResult<TData, TError>,
  ) => this is CreateBaseQueryResult<
    TData,
    TError,
    CreateStatusBasedQueryResult<'pending', TData, TError>
  >
  // Warning: (ae-forgotten-export) The symbol "CreateStatusBasedQueryResult" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  isSuccess: (
    this: CreateBaseQueryResult<TData, TError>,
  ) => this is CreateBaseQueryResult<
    TData,
    TError,
    CreateStatusBasedQueryResult<'success', TData, TError>
  >
}

// Warning: (ae-forgotten-export) The symbol "Override" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type CreateBaseMutationResult<
  TData = unknown,
  TError = DefaultError,
  TVariables = unknown,
  TContext = unknown,
> = Override<
  MutationObserverResult<TData, TError, TVariables, TContext>,
  {
    mutate: CreateMutateFunction<TData, TError, TVariables, TContext>
  }
> & {
  mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
}

// @public (undocumented)
export interface CreateBaseQueryOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
> extends QueryObserverOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryData,
    TQueryKey
  > {}

// Warning: (ae-forgotten-export) The symbol "MapToSignals" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type CreateBaseQueryResult<
  TData = unknown,
  TError = DefaultError,
  TState = QueryObserverResult<TData, TError>,
> = BaseQueryNarrowing<TData, TError> &
  MapToSignals<OmitKeyof<TState, keyof BaseQueryNarrowing, 'safely'>>

// @public (undocumented)
export interface CreateInfiniteQueryOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
> extends OmitKeyof<
    InfiniteQueryObserverOptions<
      TQueryFnData,
      TError,
      TData,
      TQueryData,
      TQueryKey,
      TPageParam
    >,
    'suspense'
  > {}

// @public (undocumented)
export type CreateInfiniteQueryResult<
  TData = unknown,
  TError = DefaultError,
> = MapToSignals<InfiniteQueryObserverResult<TData, TError>>

// @public (undocumented)
export type CreateMutateAsyncFunction<
  TData = unknown,
  TError = DefaultError,
  TVariables = void,
  TContext = unknown,
> = MutateFunction<TData, TError, TVariables, TContext>

// @public (undocumented)
export type CreateMutateFunction<
  TData = unknown,
  TError = DefaultError,
  TVariables = void,
  TContext = unknown,
> = (
  ...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
) => void

// @public (undocumented)
export interface CreateMutationOptions<
  TData = unknown,
  TError = DefaultError,
  TVariables = void,
  TContext = unknown,
> extends OmitKeyof<
    MutationObserverOptions<TData, TError, TVariables, TContext>,
    '_defaulted'
  > {}

// @public (undocumented)
export type CreateMutationResult<
  TData = unknown,
  TError = DefaultError,
  TVariables = unknown,
  TContext = unknown,
  TState = CreateStatusBasedMutationResult<
    CreateBaseMutationResult['status'],
    TData,
    TError,
    TVariables,
    TContext
  >,
> = BaseMutationNarrowing<TData, TError, TVariables, TContext> &
  MapToSignals<OmitKeyof<TState, keyof BaseMutationNarrowing, 'safely'>>

// @public (undocumented)
export interface CreateQueryOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
> extends OmitKeyof<
    CreateBaseQueryOptions<
      TQueryFnData,
      TError,
      TData,
      TQueryFnData,
      TQueryKey
    >,
    'suspense'
  > {}

// @public (undocumented)
export type CreateQueryResult<
  TData = unknown,
  TError = DefaultError,
> = CreateBaseQueryResult<TData, TError>

// @public (undocumented)
export type DefinedCreateInfiniteQueryResult<
  TData = unknown,
  TError = DefaultError,
  TDefinedInfiniteQueryObserver = DefinedInfiniteQueryObserverResult<
    TData,
    TError
  >,
> = MapToSignals<TDefinedInfiniteQueryObserver>

// @public (undocumented)
export type DefinedCreateQueryResult<
  TData = unknown,
  TError = DefaultError,
  TDefinedQueryObserver = DefinedQueryObserverResult<TData, TError>,
> = MapToSignals<TDefinedQueryObserver>

// @public (undocumented)
export type DefinedInitialDataInfiniteOptions<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
> = CreateInfiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryFnData,
  TQueryKey,
  TPageParam
> & {
  initialData:
    | NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>
    | (() => NonUndefinedGuard<InfiniteData<TQueryFnData, TPageParam>>)
}

// @public (undocumented)
export type DefinedInitialDataOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
  initialData:
    | NonUndefinedGuard<TQueryFnData>
    | (() => NonUndefinedGuard<TQueryFnData>)
}

// @public
export function infiniteQueryOptions<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
>(
  options: UndefinedInitialDataInfiniteOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >,
): UndefinedInitialDataInfiniteOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam
> & {
  queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
}

// @public
export function infiniteQueryOptions<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
>(
  options: DefinedInitialDataInfiniteOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >,
): DefinedInitialDataInfiniteOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam
> & {
  queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>
}

// @public
export function injectInfiniteQuery<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
>(
  optionsFn: (
    client: QueryClient,
  ) => UndefinedInitialDataInfiniteOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >,
  injector?: Injector,
): CreateInfiniteQueryResult<TData, TError>

// @public
export function injectInfiniteQuery<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
>(
  optionsFn: (
    client: QueryClient,
  ) => DefinedInitialDataInfiniteOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >,
  injector?: Injector,
): DefinedCreateInfiniteQueryResult<TData, TError>

// @public
export function injectInfiniteQuery<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
>(
  optionsFn: (
    client: QueryClient,
  ) => CreateInfiniteQueryOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryFnData,
    TQueryKey,
    TPageParam
  >,
  injector?: Injector,
): CreateInfiniteQueryResult<TData, TError>

// @public
export function injectIsFetching(
  filters?: QueryFilters,
  injector?: Injector,
): Signal<number>

// @public
export function injectIsMutating(
  filters?: MutationFilters,
  injector?: Injector,
): Signal<number>

// @public
export function injectMutation<
  TData = unknown,
  TError = DefaultError,
  TVariables = void,
  TContext = unknown,
>(
  optionsFn: (
    client: QueryClient,
  ) => CreateMutationOptions<TData, TError, TVariables, TContext>,
  injector?: Injector,
): CreateMutationResult<TData, TError, TVariables, TContext>

// Warning: (ae-forgotten-export) The symbol "MutationStateOptions" needs to be exported by the entry point index.d.ts
//
// @public
export function injectMutationState<TResult = MutationState>(
  mutationStateOptionsFn?: () => MutationStateOptions<TResult>,
  options?: InjectMutationStateOptions,
): Signal<Array<TResult>>

// @public (undocumented)
export interface InjectMutationStateOptions {
  // (undocumented)
  injector?: Injector
}

// @public (undocumented)
export function injectQueries<
  T extends Array<any>,
  TCombinedResult = QueriesResults<T>,
>(
  {
    queries,
    ...options
  }: {
    queries: Signal<[...QueriesOptions<T>]>
    combine?: (result: QueriesResults<T>) => TCombinedResult
  },
  injector?: Injector,
): Signal<TCombinedResult>

// @public
export function injectQuery<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
>(
  optionsFn: (
    client: QueryClient,
  ) => DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
  injector?: Injector,
): DefinedCreateQueryResult<TData, TError>

// @public
export function injectQuery<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
>(
  optionsFn: (
    client: QueryClient,
  ) => UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
  injector?: Injector,
): CreateQueryResult<TData, TError>

// @public
export function injectQuery<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
>(
  optionsFn: (
    client: QueryClient,
  ) => CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
  injector?: Injector,
): CreateQueryResult<TData, TError>

// @public
export const injectQueryClient: {
  (): QueryClient
  (
    injectOptions: InjectOptions & {
      optional?: false
    } & {
      injector?: Injector
    },
  ): QueryClient
  (
    injectOptions: InjectOptions & {
      injector?: Injector
    },
  ): QueryClient
}

// @public (undocumented)
export type NonUndefinedGuard<T> = T extends undefined ? never : T

// @public
export function provideAngularQuery(
  queryClient: QueryClient,
): EnvironmentProviders

// @public
export const provideQueryClient: ((
  value: QueryClient | (() => QueryClient),
) => Provider) &
  ((value: QueryClient | (() => QueryClient)) => Provider)

// Warning: (ae-forgotten-export) The symbol "MAXIMUM_DEPTH" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "QueryObserverOptionsForCreateQueries" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "GetOptions" needs to be exported by the entry point index.d.ts
//
// @public
export type QueriesOptions<
  T extends Array<any>,
  TResult extends Array<any> = [],
  TDepth extends ReadonlyArray<number> = [],
> = TDepth['length'] extends MAXIMUM_DEPTH
  ? Array<QueryObserverOptionsForCreateQueries>
  : T extends []
    ? []
    : T extends [infer Head]
      ? [...TResult, GetOptions<Head>]
      : T extends [infer Head, ...infer Tail]
        ? QueriesOptions<
            [...Tail],
            [...TResult, GetOptions<Head>],
            [...TDepth, 1]
          >
        : ReadonlyArray<unknown> extends T
          ? T
          : T extends Array<
                QueryObserverOptionsForCreateQueries<
                  infer TQueryFnData,
                  infer TError,
                  infer TData,
                  infer TQueryKey
                >
              >
            ? Array<
                QueryObserverOptionsForCreateQueries<
                  TQueryFnData,
                  TError,
                  TData,
                  TQueryKey
                >
              >
            : Array<QueryObserverOptionsForCreateQueries>

// Warning: (ae-forgotten-export) The symbol "GetResults" needs to be exported by the entry point index.d.ts
//
// @public
export type QueriesResults<
  T extends Array<any>,
  TResult extends Array<any> = [],
  TDepth extends ReadonlyArray<number> = [],
> = TDepth['length'] extends MAXIMUM_DEPTH
  ? Array<QueryObserverResult>
  : T extends []
    ? []
    : T extends [infer Head]
      ? [...TResult, GetResults<Head>]
      : T extends [infer Head, ...infer Tail]
        ? QueriesResults<
            [...Tail],
            [...TResult, GetResults<Head>],
            [...TDepth, 1]
          >
        : T extends Array<
              QueryObserverOptionsForCreateQueries<
                infer TQueryFnData,
                infer TError,
                infer TData,
                any
              >
            >
          ? Array<
              QueryObserverResult<
                unknown extends TData ? TQueryFnData : TData,
                unknown extends TError ? DefaultError : TError
              >
            >
          : Array<QueryObserverResult>

// @public
export function queryOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
>(
  options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
  queryKey: DataTag<TQueryKey, TQueryFnData>
}

// @public
export function queryOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
>(
  options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & {
  queryKey: DataTag<TQueryKey, TQueryFnData>
}

// @public (undocumented)
export type UndefinedInitialDataInfiniteOptions<
  TQueryFnData,
  TError = DefaultError,
  TData = InfiniteData<TQueryFnData>,
  TQueryKey extends QueryKey = QueryKey,
  TPageParam = unknown,
> = CreateInfiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryFnData,
  TQueryKey,
  TPageParam
> & {
  initialData?: undefined
}

// @public (undocumented)
export type UndefinedInitialDataOptions<
  TQueryFnData = unknown,
  TError = DefaultError,
  TData = TQueryFnData,
  TQueryKey extends QueryKey = QueryKey,
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
  initialData?: undefined
}

export * from '@tanstack/query-core'

// (No @packageDocumentation comment for this package)