@tanstack/svelte-query 5.0.5 → 5.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/createBaseQuery.d.ts +2 -2
- package/dist/createBaseQuery.d.ts.map +1 -1
- package/dist/createInfiniteQuery.d.ts +2 -2
- package/dist/createInfiniteQuery.d.ts.map +1 -1
- package/dist/createQuery.d.ts +4 -10
- package/dist/createQuery.d.ts.map +1 -1
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/infiniteQueryOptions.d.ts +4 -0
- package/dist/infiniteQueryOptions.d.ts.map +1 -0
- package/dist/infiniteQueryOptions.js +3 -0
- package/dist/queryOptions.d.ts +13 -0
- package/dist/queryOptions.d.ts.map +1 -0
- package/dist/queryOptions.js +3 -0
- package/dist/types.d.ts +4 -4
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/createBaseQuery.ts +7 -7
- package/src/createInfiniteQuery.ts +10 -7
- package/src/createQuery.ts +14 -21
- package/src/index.ts +7 -0
- package/src/infiniteQueryOptions.ts +28 -0
- package/src/queryOptions.ts +46 -0
- package/src/types.ts +10 -14
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { QueryClient, QueryKey, QueryObserver } from '@tanstack/query-core';
|
|
2
|
-
import type { CreateBaseQueryOptions, CreateBaseQueryResult } from './types';
|
|
3
|
-
export declare function createBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options: CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey
|
|
2
|
+
import type { CreateBaseQueryOptions, CreateBaseQueryResult, StoreOrVal } from './types';
|
|
3
|
+
export declare function createBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options: StoreOrVal<CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>>, Observer: typeof QueryObserver, queryClient?: QueryClient): CreateBaseQueryResult<TData, TError>;
|
|
4
4
|
//# sourceMappingURL=createBaseQuery.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createBaseQuery.d.ts","sourceRoot":"","sources":["../../../src/createBaseQuery.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,aAAa,EAEd,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"createBaseQuery.d.ts","sourceRoot":"","sources":["../../../src/createBaseQuery.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,aAAa,EAEd,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,sBAAsB,EACtB,qBAAqB,EACrB,UAAU,EACX,MAAM,SAAS,CAAA;AAEhB,wBAAgB,eAAe,CAC7B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,EACV,SAAS,SAAS,QAAQ,EAE1B,OAAO,EAAE,UAAU,CACjB,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAC3E,EACD,QAAQ,EAAE,OAAO,aAAa,EAC9B,WAAW,CAAC,EAAE,WAAW,GACxB,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAyDtC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { DefaultError, InfiniteData, QueryClient, QueryKey } from '@tanstack/query-core';
|
|
2
|
-
import type { CreateInfiniteQueryOptions, CreateInfiniteQueryResult } from './types';
|
|
3
|
-
export declare function createInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam
|
|
2
|
+
import type { CreateInfiniteQueryOptions, CreateInfiniteQueryResult, StoreOrVal } from './types';
|
|
3
|
+
export declare function createInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: StoreOrVal<CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>, queryClient?: QueryClient): CreateInfiniteQueryResult<TData, TError>;
|
|
4
4
|
//# sourceMappingURL=createInfiniteQuery.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createInfiniteQuery.d.ts","sourceRoot":"","sources":["../../../src/createInfiniteQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,QAAQ,EAET,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,0BAA0B,EAC1B,yBAAyB,
|
|
1
|
+
{"version":3,"file":"createInfiniteQuery.d.ts","sourceRoot":"","sources":["../../../src/createInfiniteQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,QAAQ,EAET,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,UAAU,EACX,MAAM,SAAS,CAAA;AAEhB,wBAAgB,mBAAmB,CACjC,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,EAEpB,OAAO,EAAE,UAAU,CACjB,0BAA0B,CACxB,YAAY,EACZ,MAAM,EACN,KAAK,EACL,YAAY,EACZ,SAAS,EACT,UAAU,CACX,CACF,EACD,WAAW,CAAC,EAAE,WAAW,GACxB,yBAAyB,CAAC,KAAK,EAAE,MAAM,CAAC,CAO1C"}
|
package/dist/createQuery.d.ts
CHANGED
|
@@ -1,12 +1,6 @@
|
|
|
1
1
|
import type { DefaultError, QueryClient, QueryKey } from '@tanstack/query-core';
|
|
2
|
-
import type {
|
|
3
|
-
type
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
7
|
-
initialData: TQueryFnData | (() => TQueryFnData);
|
|
8
|
-
};
|
|
9
|
-
export declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): CreateQueryResult<TData, TError>;
|
|
10
|
-
export declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): DefinedCreateQueryResult<TData, TError>;
|
|
11
|
-
export {};
|
|
2
|
+
import type { CreateQueryResult, DefinedCreateQueryResult, StoreOrVal } from './types';
|
|
3
|
+
import type { DefinedInitialDataOptions, UndefinedInitialDataOptions } from './queryOptions';
|
|
4
|
+
export declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: StoreOrVal<UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>>, queryClient?: QueryClient): CreateQueryResult<TData, TError>;
|
|
5
|
+
export declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: StoreOrVal<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>>, queryClient?: QueryClient): DefinedCreateQueryResult<TData, TError>;
|
|
12
6
|
//# sourceMappingURL=createQuery.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createQuery.d.ts","sourceRoot":"","sources":["../../../src/createQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/E,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"createQuery.d.ts","sourceRoot":"","sources":["../../../src/createQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/E,OAAO,KAAK,EAEV,iBAAiB,EACjB,wBAAwB,EACxB,UAAU,EACX,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EACV,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAA;AAEvB,wBAAgB,WAAW,CACzB,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,UAAU,CACjB,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CACpE,EACD,WAAW,CAAC,EAAE,WAAW,GACxB,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAEnC,wBAAgB,WAAW,CACzB,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,UAAU,CACjB,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAClE,EACD,WAAW,CAAC,EAAE,WAAW,GACxB,wBAAwB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,8 +2,11 @@ export * from '@tanstack/query-core';
|
|
|
2
2
|
export * from './types';
|
|
3
3
|
export * from './context';
|
|
4
4
|
export { createQuery } from './createQuery';
|
|
5
|
+
export type { DefinedInitialDataOptions, UndefinedInitialDataOptions, } from './queryOptions';
|
|
6
|
+
export { queryOptions } from './queryOptions';
|
|
5
7
|
export { createQueries } from './createQueries';
|
|
6
8
|
export { createInfiniteQuery } from './createInfiniteQuery';
|
|
9
|
+
export { infiniteQueryOptions } from './infiniteQueryOptions';
|
|
7
10
|
export { createMutation } from './createMutation';
|
|
8
11
|
export { useQueryClient } from './useQueryClient';
|
|
9
12
|
export { useIsFetching } from './useIsFetching';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,sBAAsB,CAAA;AAGpC,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAGA,cAAc,sBAAsB,CAAA;AAGpC,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,YAAY,EACV,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AACzE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,8BAA8B,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -5,8 +5,10 @@ export * from '@tanstack/query-core';
|
|
|
5
5
|
export * from './types';
|
|
6
6
|
export * from './context';
|
|
7
7
|
export { createQuery } from './createQuery';
|
|
8
|
+
export { queryOptions } from './queryOptions';
|
|
8
9
|
export { createQueries } from './createQueries';
|
|
9
10
|
export { createInfiniteQuery } from './createInfiniteQuery';
|
|
11
|
+
export { infiniteQueryOptions } from './infiniteQueryOptions';
|
|
10
12
|
export { createMutation } from './createMutation';
|
|
11
13
|
export { useQueryClient } from './useQueryClient';
|
|
12
14
|
export { useIsFetching } from './useIsFetching';
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { DefaultError, InfiniteData, QueryKey } from '@tanstack/query-core';
|
|
2
|
+
import type { CreateInfiniteQueryOptions } from './types';
|
|
3
|
+
export declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>;
|
|
4
|
+
//# sourceMappingURL=infiniteQueryOptions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"infiniteQueryOptions.d.ts","sourceRoot":"","sources":["../../../src/infiniteQueryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAChF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEzD,wBAAgB,oBAAoB,CAClC,YAAY,EACZ,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,EAClC,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,EAEpB,OAAO,EAAE,0BAA0B,CACjC,YAAY,EACZ,MAAM,EACN,KAAK,EACL,YAAY,EACZ,SAAS,EACT,UAAU,CACX,GACA,0BAA0B,CAC3B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,YAAY,EACZ,SAAS,EACT,UAAU,CACX,CAEA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { DefaultError, QueryKey } from '@tanstack/query-core';
|
|
2
|
+
import type { CreateQueryOptions } from './types';
|
|
3
|
+
export type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
4
|
+
initialData?: undefined;
|
|
5
|
+
};
|
|
6
|
+
type NonUndefinedGuard<T> = T extends undefined ? never : T;
|
|
7
|
+
export type DefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
8
|
+
initialData: NonUndefinedGuard<TQueryFnData> | (() => NonUndefinedGuard<TQueryFnData>);
|
|
9
|
+
};
|
|
10
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
11
|
+
export declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>;
|
|
12
|
+
export {};
|
|
13
|
+
//# sourceMappingURL=queryOptions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryOptions.d.ts","sourceRoot":"","sources":["../../../src/queryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,MAAM,MAAM,2BAA2B,CACrC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG;IAC/D,WAAW,CAAC,EAAE,SAAS,CAAA;CACxB,CAAA;AAED,KAAK,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAA;AAE3D,MAAM,MAAM,yBAAyB,CACnC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG;IAC/D,WAAW,EACP,iBAAiB,CAAC,YAAY,CAAC,GAC/B,CAAC,MAAM,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAA;CAC5C,CAAA;AAED,wBAAgB,YAAY,CAC1B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GAC3E,2BAA2B,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA;AAEtE,wBAAgB,YAAY,CAC1B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EAErC,OAAO,EAAE,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,GACzE,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,CAAA"}
|
package/dist/types.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { DefaultError, DefinedQueryObserverResult, InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutateFunction, MutationObserverOptions, MutationObserverResult, QueryKey, QueryObserverOptions, QueryObserverResult } from '@tanstack/query-core';
|
|
2
|
-
import type { Readable
|
|
2
|
+
import type { Readable } from 'svelte/store';
|
|
3
3
|
/** Allows a type to be either the base object or a store of that object */
|
|
4
|
-
export type StoreOrVal<T> = T | Readable<T
|
|
4
|
+
export type StoreOrVal<T> = T | Readable<T>;
|
|
5
5
|
/** Options for createBaseQuery */
|
|
6
|
-
export type CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> =
|
|
6
|
+
export type CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
|
|
7
7
|
/** Result from createBaseQuery */
|
|
8
8
|
export type CreateBaseQueryResult<TData = unknown, TError = DefaultError> = Readable<QueryObserverResult<TData, TError>>;
|
|
9
9
|
/** Options for createQuery */
|
|
@@ -11,7 +11,7 @@ export type CreateQueryOptions<TQueryFnData = unknown, TError = DefaultError, TD
|
|
|
11
11
|
/** Result from createQuery */
|
|
12
12
|
export type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
|
|
13
13
|
/** Options for createInfiniteQuery */
|
|
14
|
-
export type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> =
|
|
14
|
+
export type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
|
|
15
15
|
/** Result from createInfiniteQuery */
|
|
16
16
|
export type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = Readable<InfiniteQueryObserverResult<TData, TError>>;
|
|
17
17
|
/** Options for createBaseQuery with initialData */
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,cAAc,EACd,uBAAuB,EACvB,sBAAsB,EACtB,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,QAAQ,EAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,4BAA4B,EAC5B,2BAA2B,EAC3B,cAAc,EACd,uBAAuB,EACvB,sBAAsB,EACtB,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAE5C,2EAA2E;AAC3E,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAA;AAE3C,kCAAkC;AAClC,MAAM,MAAM,sBAAsB,CAChC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,EACzB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;AAE5E,kCAAkC;AAClC,MAAM,MAAM,qBAAqB,CAC/B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;AAEhD,8BAA8B;AAC9B,MAAM,MAAM,kBAAkB,CAC5B,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,SAAS,SAAS,QAAQ,GAAG,QAAQ,IACnC,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,CAAA;AAEhF,8BAA8B;AAC9B,MAAM,MAAM,iBAAiB,CAC3B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAExC,sCAAsC;AACtC,MAAM,MAAM,0BAA0B,CACpC,YAAY,GAAG,OAAO,EACtB,MAAM,GAAG,YAAY,EACrB,KAAK,GAAG,YAAY,EACpB,UAAU,GAAG,YAAY,EACzB,SAAS,SAAS,QAAQ,GAAG,QAAQ,EACrC,UAAU,GAAG,OAAO,IAClB,4BAA4B,CAC9B,YAAY,EACZ,MAAM,EACN,KAAK,EACL,UAAU,EACV,SAAS,EACT,UAAU,CACX,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,yBAAyB,CACnC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,QAAQ,CAAC,2BAA2B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;AAExD,mDAAmD;AACnD,MAAM,MAAM,4BAA4B,CACtC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,QAAQ,CAAC,0BAA0B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;AAEvD,+CAA+C;AAC/C,MAAM,MAAM,wBAAwB,CAClC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,IACnB,4BAA4B,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;AAE/C,iCAAiC;AACjC,MAAM,MAAM,qBAAqB,CAC/B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,OAAO,IAChB,UAAU,CACZ,IAAI,CACF,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC5D,YAAY,GAAG,WAAW,CAC3B,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,CAC9B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,OAAO,IAChB,CACF,GAAG,IAAI,EAAE,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,KACrE,IAAI,CAAA;AAET,MAAM,MAAM,yBAAyB,CACnC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,OAAO,IAChB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAA;AAEvD,MAAM,MAAM,wBAAwB,CAClC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EACpB,QAAQ,GAAG,OAAO,IAChB,QAAQ,CACV,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,EAC3D;IAAE,MAAM,EAAE,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAA;CAAE,CACtE,GAAG;IACF,WAAW,EAAE,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAA;CAC5E,CAAA;AAED,iCAAiC;AACjC,MAAM,MAAM,oBAAoB,CAC9B,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,YAAY,EACrB,UAAU,GAAG,OAAO,EACpB,QAAQ,GAAG,OAAO,IAChB,QAAQ,CAAC,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;AAE3E,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA"}
|
package/package.json
CHANGED
package/src/createBaseQuery.ts
CHANGED
|
@@ -9,7 +9,11 @@ import type {
|
|
|
9
9
|
QueryObserver,
|
|
10
10
|
QueryObserverResult,
|
|
11
11
|
} from '@tanstack/query-core'
|
|
12
|
-
import type {
|
|
12
|
+
import type {
|
|
13
|
+
CreateBaseQueryOptions,
|
|
14
|
+
CreateBaseQueryResult,
|
|
15
|
+
StoreOrVal,
|
|
16
|
+
} from './types'
|
|
13
17
|
|
|
14
18
|
export function createBaseQuery<
|
|
15
19
|
TQueryFnData,
|
|
@@ -18,12 +22,8 @@ export function createBaseQuery<
|
|
|
18
22
|
TQueryData,
|
|
19
23
|
TQueryKey extends QueryKey,
|
|
20
24
|
>(
|
|
21
|
-
options:
|
|
22
|
-
TQueryFnData,
|
|
23
|
-
TError,
|
|
24
|
-
TData,
|
|
25
|
-
TQueryData,
|
|
26
|
-
TQueryKey
|
|
25
|
+
options: StoreOrVal<
|
|
26
|
+
CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
|
|
27
27
|
>,
|
|
28
28
|
Observer: typeof QueryObserver,
|
|
29
29
|
queryClient?: QueryClient,
|
|
@@ -10,6 +10,7 @@ import type {
|
|
|
10
10
|
import type {
|
|
11
11
|
CreateInfiniteQueryOptions,
|
|
12
12
|
CreateInfiniteQueryResult,
|
|
13
|
+
StoreOrVal,
|
|
13
14
|
} from './types'
|
|
14
15
|
|
|
15
16
|
export function createInfiniteQuery<
|
|
@@ -19,13 +20,15 @@ export function createInfiniteQuery<
|
|
|
19
20
|
TQueryKey extends QueryKey = QueryKey,
|
|
20
21
|
TPageParam = unknown,
|
|
21
22
|
>(
|
|
22
|
-
options:
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
23
|
+
options: StoreOrVal<
|
|
24
|
+
CreateInfiniteQueryOptions<
|
|
25
|
+
TQueryFnData,
|
|
26
|
+
TError,
|
|
27
|
+
TData,
|
|
28
|
+
TQueryFnData,
|
|
29
|
+
TQueryKey,
|
|
30
|
+
TPageParam
|
|
31
|
+
>
|
|
29
32
|
>,
|
|
30
33
|
queryClient?: QueryClient,
|
|
31
34
|
): CreateInfiniteQueryResult<TData, TError> {
|
package/src/createQuery.ts
CHANGED
|
@@ -5,25 +5,12 @@ import type {
|
|
|
5
5
|
CreateQueryOptions,
|
|
6
6
|
CreateQueryResult,
|
|
7
7
|
DefinedCreateQueryResult,
|
|
8
|
+
StoreOrVal,
|
|
8
9
|
} from './types'
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
TData = TQueryFnData,
|
|
14
|
-
TQueryKey extends QueryKey = QueryKey,
|
|
15
|
-
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
16
|
-
initialData?: undefined
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
type DefinedInitialDataOptions<
|
|
20
|
-
TQueryFnData = unknown,
|
|
21
|
-
TError = DefaultError,
|
|
22
|
-
TData = TQueryFnData,
|
|
23
|
-
TQueryKey extends QueryKey = QueryKey,
|
|
24
|
-
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
25
|
-
initialData: TQueryFnData | (() => TQueryFnData)
|
|
26
|
-
}
|
|
10
|
+
import type {
|
|
11
|
+
DefinedInitialDataOptions,
|
|
12
|
+
UndefinedInitialDataOptions,
|
|
13
|
+
} from './queryOptions'
|
|
27
14
|
|
|
28
15
|
export function createQuery<
|
|
29
16
|
TQueryFnData = unknown,
|
|
@@ -31,7 +18,9 @@ export function createQuery<
|
|
|
31
18
|
TData = TQueryFnData,
|
|
32
19
|
TQueryKey extends QueryKey = QueryKey,
|
|
33
20
|
>(
|
|
34
|
-
options:
|
|
21
|
+
options: StoreOrVal<
|
|
22
|
+
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
23
|
+
>,
|
|
35
24
|
queryClient?: QueryClient,
|
|
36
25
|
): CreateQueryResult<TData, TError>
|
|
37
26
|
|
|
@@ -41,7 +30,9 @@ export function createQuery<
|
|
|
41
30
|
TData = TQueryFnData,
|
|
42
31
|
TQueryKey extends QueryKey = QueryKey,
|
|
43
32
|
>(
|
|
44
|
-
options:
|
|
33
|
+
options: StoreOrVal<
|
|
34
|
+
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
35
|
+
>,
|
|
45
36
|
queryClient?: QueryClient,
|
|
46
37
|
): DefinedCreateQueryResult<TData, TError>
|
|
47
38
|
|
|
@@ -51,7 +42,9 @@ export function createQuery<
|
|
|
51
42
|
TData = TQueryFnData,
|
|
52
43
|
TQueryKey extends QueryKey = QueryKey,
|
|
53
44
|
>(
|
|
54
|
-
options:
|
|
45
|
+
options: StoreOrVal<
|
|
46
|
+
CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
47
|
+
>,
|
|
55
48
|
queryClient?: QueryClient,
|
|
56
49
|
) {
|
|
57
50
|
return createBaseQuery(options, QueryObserver, queryClient)
|
package/src/index.ts
CHANGED
|
@@ -6,9 +6,16 @@ export * from '@tanstack/query-core'
|
|
|
6
6
|
// Svelte Query
|
|
7
7
|
export * from './types'
|
|
8
8
|
export * from './context'
|
|
9
|
+
|
|
9
10
|
export { createQuery } from './createQuery'
|
|
11
|
+
export type {
|
|
12
|
+
DefinedInitialDataOptions,
|
|
13
|
+
UndefinedInitialDataOptions,
|
|
14
|
+
} from './queryOptions'
|
|
15
|
+
export { queryOptions } from './queryOptions'
|
|
10
16
|
export { createQueries } from './createQueries'
|
|
11
17
|
export { createInfiniteQuery } from './createInfiniteQuery'
|
|
18
|
+
export { infiniteQueryOptions } from './infiniteQueryOptions'
|
|
12
19
|
export { createMutation } from './createMutation'
|
|
13
20
|
export { useQueryClient } from './useQueryClient'
|
|
14
21
|
export { useIsFetching } from './useIsFetching'
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { DefaultError, InfiniteData, QueryKey } from '@tanstack/query-core'
|
|
2
|
+
import type { CreateInfiniteQueryOptions } from './types'
|
|
3
|
+
|
|
4
|
+
export function infiniteQueryOptions<
|
|
5
|
+
TQueryFnData,
|
|
6
|
+
TError = DefaultError,
|
|
7
|
+
TData = InfiniteData<TQueryFnData>,
|
|
8
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
9
|
+
TPageParam = unknown,
|
|
10
|
+
>(
|
|
11
|
+
options: CreateInfiniteQueryOptions<
|
|
12
|
+
TQueryFnData,
|
|
13
|
+
TError,
|
|
14
|
+
TData,
|
|
15
|
+
TQueryFnData,
|
|
16
|
+
TQueryKey,
|
|
17
|
+
TPageParam
|
|
18
|
+
>,
|
|
19
|
+
): CreateInfiniteQueryOptions<
|
|
20
|
+
TQueryFnData,
|
|
21
|
+
TError,
|
|
22
|
+
TData,
|
|
23
|
+
TQueryFnData,
|
|
24
|
+
TQueryKey,
|
|
25
|
+
TPageParam
|
|
26
|
+
> {
|
|
27
|
+
return options
|
|
28
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { DefaultError, QueryKey } from '@tanstack/query-core'
|
|
2
|
+
import type { CreateQueryOptions } from './types'
|
|
3
|
+
|
|
4
|
+
export type UndefinedInitialDataOptions<
|
|
5
|
+
TQueryFnData = unknown,
|
|
6
|
+
TError = DefaultError,
|
|
7
|
+
TData = TQueryFnData,
|
|
8
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
9
|
+
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
10
|
+
initialData?: undefined
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
type NonUndefinedGuard<T> = T extends undefined ? never : T
|
|
14
|
+
|
|
15
|
+
export type DefinedInitialDataOptions<
|
|
16
|
+
TQueryFnData = unknown,
|
|
17
|
+
TError = DefaultError,
|
|
18
|
+
TData = TQueryFnData,
|
|
19
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
20
|
+
> = CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
21
|
+
initialData:
|
|
22
|
+
| NonUndefinedGuard<TQueryFnData>
|
|
23
|
+
| (() => NonUndefinedGuard<TQueryFnData>)
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export function queryOptions<
|
|
27
|
+
TQueryFnData = unknown,
|
|
28
|
+
TError = DefaultError,
|
|
29
|
+
TData = TQueryFnData,
|
|
30
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
31
|
+
>(
|
|
32
|
+
options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
|
|
33
|
+
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
34
|
+
|
|
35
|
+
export function queryOptions<
|
|
36
|
+
TQueryFnData = unknown,
|
|
37
|
+
TError = DefaultError,
|
|
38
|
+
TData = TQueryFnData,
|
|
39
|
+
TQueryKey extends QueryKey = QueryKey,
|
|
40
|
+
>(
|
|
41
|
+
options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
|
|
42
|
+
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
|
|
43
|
+
|
|
44
|
+
export function queryOptions(options: unknown) {
|
|
45
|
+
return options
|
|
46
|
+
}
|
package/src/types.ts
CHANGED
|
@@ -10,10 +10,10 @@ import type {
|
|
|
10
10
|
QueryObserverOptions,
|
|
11
11
|
QueryObserverResult,
|
|
12
12
|
} from '@tanstack/query-core'
|
|
13
|
-
import type { Readable
|
|
13
|
+
import type { Readable } from 'svelte/store'
|
|
14
14
|
|
|
15
15
|
/** Allows a type to be either the base object or a store of that object */
|
|
16
|
-
export type StoreOrVal<T> = T | Readable<T>
|
|
16
|
+
export type StoreOrVal<T> = T | Readable<T>
|
|
17
17
|
|
|
18
18
|
/** Options for createBaseQuery */
|
|
19
19
|
export type CreateBaseQueryOptions<
|
|
@@ -22,9 +22,7 @@ export type CreateBaseQueryOptions<
|
|
|
22
22
|
TData = TQueryFnData,
|
|
23
23
|
TQueryData = TQueryFnData,
|
|
24
24
|
TQueryKey extends QueryKey = QueryKey,
|
|
25
|
-
> =
|
|
26
|
-
QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
|
|
27
|
-
>
|
|
25
|
+
> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
|
|
28
26
|
|
|
29
27
|
/** Result from createBaseQuery */
|
|
30
28
|
export type CreateBaseQueryResult<
|
|
@@ -54,15 +52,13 @@ export type CreateInfiniteQueryOptions<
|
|
|
54
52
|
TQueryData = TQueryFnData,
|
|
55
53
|
TQueryKey extends QueryKey = QueryKey,
|
|
56
54
|
TPageParam = unknown,
|
|
57
|
-
> =
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
TPageParam
|
|
65
|
-
>
|
|
55
|
+
> = InfiniteQueryObserverOptions<
|
|
56
|
+
TQueryFnData,
|
|
57
|
+
TError,
|
|
58
|
+
TData,
|
|
59
|
+
TQueryData,
|
|
60
|
+
TQueryKey,
|
|
61
|
+
TPageParam
|
|
66
62
|
>
|
|
67
63
|
|
|
68
64
|
/** Result from createInfiniteQuery */
|