@alphanova/builder
Version:
A fully fledged facade that facilitates object manipulation
999 lines (998 loc) • 40.7 kB
TypeScript
import { useContainerType, useStorageReturn, useStructureType } from './Redux';
import { QueryKey, UseQueryOptions } from '@tanstack/react-query';
import { Rule } from './Models/Config';
import { Structure } from './Models/Document';
type Options<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
initialData: unknown | (() => unknown);
};
/**
*
* @param _typer This is the raw getConfig() file you used to setup the package. You do not have to provide this parameter. It is only used for type checking but it is recommended to provide it. Not providing it would require you to type-cast the return value of the hook.
* @param key This is the list of the models that will be provided by using the useStorage hook. It is pulled from the action name property in the configs. Do not provide actions that will not be used as it will slow down the hook.
* @returns A Record holding the functions that will be used to interact with the Redux store. The functions are named after the actions provided in the configs. Do not use functions that you did not provide.
* @deprecated
*/
export declare function useStorage<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T): useStorageReturn<C, T>;
export declare function useFetchMany<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchAny<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, route: string[], params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchOne<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, id: string, params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
dataMap: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchManyArray<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: useContainerType<C, T>[];
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchAnyArray<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, route: string[], params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: useContainerType<C, T>[];
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchOneArray<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, id: string, params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: useContainerType<C, T>[];
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: useContainerType<C, T>[];
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchManyMap<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchAnyMap<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, route: string[], params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useFetchOneMap<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, id: string, params?: Options<useContainerType<C, T>[], unknown, useContainerType<C, T>[], QueryKey>, override_url?: string): {
data: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: false;
isRefetchError: true;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: false;
isLoadingError: false;
isRefetchError: false;
isSuccess: true;
status: "success";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: unknown;
isError: true;
isLoading: false;
isLoadingError: true;
isRefetchError: false;
isSuccess: false;
status: "error";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
} | {
data: Map<string, useContainerType<C, T>>;
error: null;
isError: false;
isLoading: true;
isLoadingError: false;
isRefetchError: false;
isSuccess: false;
status: "loading";
dataUpdatedAt: number;
errorUpdatedAt: number;
failureCount: number;
failureReason: unknown;
errorUpdateCount: number;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isInitialLoading: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetching: boolean;
isStale: boolean;
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<useContainerType<C, T>[], unknown>>;
remove: () => void;
fetchStatus: import("@tanstack/react-query").FetchStatus;
};
export declare function useAddLocal<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): (id: string, payload: useContainerType<C, T>["extract"]) => useContainerType<C, T>;
export declare function useUpdateLocal<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): (id: string, object: useStructureType<C, T>) => useContainerType<C, T>;
export declare function useDeleteLocal<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): (id: string) => useContainerType<C, T>;
export declare function useAdd<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): import("@tanstack/react-query").UseMutationResult<useContainerType<C, T>, unknown, {
payload: useContainerType<C, T>["extract"];
extra?: Record<string, unknown> | undefined;
}, unknown>;
export declare function useDelete<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): import("@tanstack/react-query").UseMutationResult<useContainerType<C, T>, unknown, {
id: string;
}, unknown>;
export declare function useUpdate<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): import("@tanstack/react-query").UseMutationResult<useContainerType<C, T>, unknown, {
id: string;
object: useContainerType<C, T>["extract"];
}, unknown>;
export declare function useServerAdd<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): import("@tanstack/react-query").UseMutationResult<useContainerType<C, T>, unknown, {
payload: useContainerType<C, T>["extract"];
extra: Record<string, unknown>;
}, unknown>;
export declare function useServerDelete<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): import("@tanstack/react-query").UseMutationResult<useContainerType<C, T>, unknown, {
id: string;
}, unknown>;
export declare function useServerUpdate<T extends C[number]['action'] | 'ERRONEOUS', C extends Rule<any, Structure, any>[]>(_typer: C, key: T, override_url?: string): import("@tanstack/react-query").UseMutationResult<useContainerType<C, T>, unknown, {
id: string;
object: useStructureType<C, T>;
}, unknown>;
export {};