API reference

Auto-generated from the public type entry points — always in sync with the build. For prose and examples, see the API and Recipes sections.

`effector-refetch`

Export	Kind	Signature
`applyBarrier`	function	`applyBarrier(query, barrier): Q`
`attachQueryLogger`	function	`attachQueryLogger(query, options): () => void`
`attachToRoute`	function	`attachToRoute(config): void`
`cache`	function	`cache(query, opts): Q`
`combineQueries`	function	`combineQueries(queries): CombinedQueries<Q>`
`concurrency`	function	`concurrency(query, opts): Q`
`connectQuery`	function	`connectQuery(config): void`
`createBarrier`	function	`createBarrier(config): Barrier`
`createContract`	function	`createContract(c): Contract<Data>`
`createInfiniteQuery`	function	`createInfiniteQuery(config): InfiniteQuery<Params, PageParam, Page, E…`
`createJsonMutation`	function	`createJsonMutation(config): Mutation<Params, Response, RequestError,…`
`createJsonQuery`	function	`createJsonQuery(config): Query<Params, Response, RequestError, Re…`
`createJsonRequestFx`	function	`createJsonRequestFx(request, options): AbortableEffect<Params, Response, Reques…`
`createMutation`	function	`createMutation(config): Mutation<Params, Result, Error, Mapped>`
`createNetworkBarrier`	function	`createNetworkBarrier(): NetworkBarrier`
`createQuery`	function	`createQuery(config): Query<Params, Result, Error, Mapped>`
`createQueryFactory`	function	`createQueryFactory(defaults): QueryFactory`
`createRequestFx`	function	`createRequestFx(handler, options): AbortableEffect<Params, Response, Reques…`
`dehydrate`	function	`dehydrate(cache): DehydratedEntry[]`
`exponentialDelay`	function	`exponentialDelay(base, opts): DelayFn`
`getQueryData`	function	`getQueryData(query): Mapped
`hydrate`	function	`hydrate(cache, entries): void`
`inMemoryCache`	function	`inMemoryCache(options): CacheAdapter`
`invalidate`	function	`invalidate(config): void`
`ioTsContract`	function	`ioTsContract(codec): Contract<T>`
`isHttpError`	function	`isHttpError(e, status): boolean`
`isRequestError`	function	`isRequestError(e): boolean`
`isTimeoutError`	function	`isTimeoutError(e): boolean`
`isTrigger`	function	`isTrigger(value): boolean`
`isValidationError`	function	`isValidationError(e): boolean`
`keepFresh`	function	`keepFresh(query, config): Q`
`linearDelay`	function	`linearDelay(base, opts): DelayFn`
`localStorageCache`	function	`localStorageCache(options): CacheAdapter`
`normalizeRequestError`	function	`normalizeRequestError(err): RequestError`
`optimisticUpdate`	function	`optimisticUpdate(config): void`
`refetchOnReconnect`	function	`refetchOnReconnect(query, scope): () => void`
`refetchOnWindowFocus`	function	`refetchOnWindowFocus(query, scope): () => void`
`retry`	function	`retry(query, opts): Q`
`runtypesContract`	function	`runtypesContract(rt): Contract<T>`
`sessionStorageCache`	function	`sessionStorageCache(options): CacheAdapter`
`setQueryData`	function	`setQueryData(query, updater): void`
`stableStringify`	function	`stableStringify(value): string`
`standardSchemaContract`	function	`standardSchemaContract(schema): Contract<T>`
`timeout`	function	`timeout(query, ms): Q`
`update`	function	`update(config): void`
`voidCache`	function	`voidCache(): CacheAdapter`
`zodContract`	function	`zodContract(schema): Contract<T>`
`HTTP_METHODS`	const
`RequestError`	class
`ValidationError`	class
`AbortableEffect`	type	`AbortableEffect(params): Promise<Result>`
`AttachToRouteConfig`	interface
`Barrier`	interface
`CacheAdapter`	interface
`CacheConfig`	interface
`CacheEntry`	interface
`CombinedQueries`	interface
`ConcurrencyStrategy`	type
`Contract`	interface
`CreateBarrierConfig`	interface
`CreateInfiniteQueryConfig`	interface
`CreateInfiniteQueryHandlerConfig`	interface
`CreateJsonMutationConfig`	interface
`CreateJsonQueryConfig`	interface
`CreateMutationConfig`	interface
`CreateMutationHandlerConfig`	interface
`CreateQueryConfig`	interface
`CreateQueryHandlerConfig`	interface
`CreateRequestFxOptions`	interface
`DehydratedEntry`	interface
`DelayFn`	type	`DelayFn(attempt): number`
`ErrorOf`	type
`GetNextPageParamCtx`	interface
`GetPreviousPageParamCtx`	interface
`HttpMethod`	type
`InfiniteQuery`	interface
`InvalidateConfig`	interface
`InvalidatePayload`	interface
`JsonRequest`	interface
`Mutation`	interface
`MutationUnitShape`	type
`NetworkBarrier`	interface
`OptimisticUpdateConfig`	interface
`ParamsOf`	type
`Patchable`	type
`Query`	interface
`QueryEffect`	type	`QueryEffect(params): Promise<Result>`
`QueryFactory`	interface
`QueryFactoryDefaults`	interface
`QueryFinished`	interface
`QueryInspect`	interface
`QueryLogEntry`	interface
`QueryLoggerOptions`	interface
`QueryLogType`	type
`QueryStatus`	type
`QueryUnitShape`	type
`RequestContext`	interface
`ResultOf`	type
`RetryConfig`	interface
`RouteLike`	interface
`Sourced`	type
`Trigger`	interface
`UpdateFromEvent`	interface
`UpdateFromOperation`	interface

`effector-refetch/react`

Export	Kind	Signature
`useQuery`	function	`useQuery(query, options): UseQueryResult<Params, Mapped, Error>`
`useSuspenseQuery`	function	`useSuspenseQuery(query, args): Mapped`
`UseQueryOptions`	interface
`UseQueryResult`	interface

`effector-refetch/vue`

Export	Kind	Signature
`useQuery`	function	`useQuery(query, options): UseQueryVueResult<Params, Mapped, Error>`
`UseQueryOptions`	interface
`UseQueryVueResult`	interface

`effector-refetch/solid`

Export	Kind	Signature
`useQuery`	function	`useQuery(query, options): UseQuerySolidResult<Params, Mapped, Erro…`
`UseQueryOptions`	interface
`UseQuerySolidResult`	interface

API reference ​

effector-refetch ​

effector-refetch/react ​

effector-refetch/vue ​

effector-refetch/solid ​

API reference

`effector-refetch`

`effector-refetch/react`

`effector-refetch/vue`

`effector-refetch/solid`