@suspensive/react-query-4 3.2.3 → 3.3.1

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.
Files changed (91) hide show
  1. package/dist/SuspenseInfiniteQuery.cjs.map +1 -1
  2. package/dist/SuspenseInfiniteQuery.d.cts +0 -1
  3. package/dist/SuspenseInfiniteQuery.d.ts +0 -1
  4. package/dist/SuspenseInfiniteQuery.js +2 -2
  5. package/dist/SuspenseQueries.cjs +1 -33
  6. package/dist/SuspenseQueries.cjs.map +1 -1
  7. package/dist/SuspenseQueries.d.cts +1 -4
  8. package/dist/SuspenseQueries.d.ts +1 -4
  9. package/dist/SuspenseQueries.js +1 -2
  10. package/dist/SuspenseQuery.cjs +1 -28
  11. package/dist/SuspenseQuery.cjs.map +1 -1
  12. package/dist/SuspenseQuery.d.cts +1 -3
  13. package/dist/SuspenseQuery.d.ts +1 -3
  14. package/dist/SuspenseQuery.js +1 -2
  15. package/dist/{chunk-MMV3JWIQ.js → chunk-7AETAPCD.js} +2 -4
  16. package/dist/chunk-7AETAPCD.js.map +1 -0
  17. package/dist/chunk-A6D2XGKX.js +12 -0
  18. package/dist/chunk-A6D2XGKX.js.map +1 -0
  19. package/dist/{chunk-ENNHXSGH.js → chunk-BOUCJMBU.js} +1 -1
  20. package/dist/chunk-BOUCJMBU.js.map +1 -0
  21. package/dist/{chunk-PKNFF4OT.js → chunk-CLWCIHTL.js} +2 -2
  22. package/dist/{chunk-3OKEPIW3.js → chunk-IJFXQRYI.js} +1 -1
  23. package/dist/chunk-IJFXQRYI.js.map +1 -0
  24. package/dist/{chunk-D5FKB2PY.js → chunk-QYGYB5UC.js} +4 -4
  25. package/dist/chunk-QYGYB5UC.js.map +1 -0
  26. package/dist/chunk-WCKC4M3O.js +12 -0
  27. package/dist/chunk-WCKC4M3O.js.map +1 -0
  28. package/dist/chunk-YFVQ7O2B.js +12 -0
  29. package/dist/chunk-YFVQ7O2B.js.map +1 -0
  30. package/dist/index.cjs +20 -36
  31. package/dist/index.cjs.map +1 -1
  32. package/dist/index.d.cts +0 -2
  33. package/dist/index.d.ts +0 -2
  34. package/dist/index.js +12 -12
  35. package/dist/infiniteQueryOptions.cjs.map +1 -1
  36. package/dist/infiniteQueryOptions.d.cts +9 -5
  37. package/dist/infiniteQueryOptions.d.ts +9 -5
  38. package/dist/infiniteQueryOptions.js +1 -1
  39. package/dist/queryOptions.cjs +2 -3
  40. package/dist/queryOptions.cjs.map +1 -1
  41. package/dist/queryOptions.d.cts +17 -11
  42. package/dist/queryOptions.d.ts +17 -11
  43. package/dist/queryOptions.js +1 -1
  44. package/dist/useSuspenseInfiniteQuery.cjs.map +1 -1
  45. package/dist/useSuspenseInfiniteQuery.d.cts +1 -2
  46. package/dist/useSuspenseInfiniteQuery.d.ts +1 -2
  47. package/dist/useSuspenseInfiniteQuery.js +1 -1
  48. package/dist/useSuspenseQueries.cjs +1 -28
  49. package/dist/useSuspenseQueries.cjs.map +1 -1
  50. package/dist/useSuspenseQueries.d.cts +25 -46
  51. package/dist/useSuspenseQueries.d.ts +25 -46
  52. package/dist/useSuspenseQueries.js +1 -1
  53. package/dist/useSuspenseQuery.cjs +1 -25
  54. package/dist/useSuspenseQuery.cjs.map +1 -1
  55. package/dist/useSuspenseQuery.d.cts +29 -10
  56. package/dist/useSuspenseQuery.d.ts +29 -10
  57. package/dist/useSuspenseQuery.js +1 -1
  58. package/package.json +4 -4
  59. package/src/PrefetchQuery.test-d.tsx +1 -1
  60. package/src/SuspenseQueries.test-d.tsx +1 -3
  61. package/src/SuspenseQueries.tsx +1 -1
  62. package/src/SuspenseQuery.test-d.tsx +5 -6
  63. package/src/SuspenseQuery.tsx +6 -2
  64. package/src/infiniteQueryOptions.ts +9 -4
  65. package/src/queryOptions.test-d.tsx +25 -15
  66. package/src/queryOptions.ts +23 -29
  67. package/src/usePrefetchQuery.test-d.tsx +1 -1
  68. package/src/useSuspenseInfiniteQuery.ts +1 -1
  69. package/src/useSuspenseQueries.test-d.ts +4 -6
  70. package/src/useSuspenseQueries.ts +29 -114
  71. package/src/useSuspenseQuery.test-d.ts +5 -6
  72. package/src/useSuspenseQuery.ts +33 -32
  73. package/dist/OmitKeyof-CFsZLI4k.d.cts +0 -3
  74. package/dist/OmitKeyof-CFsZLI4k.d.ts +0 -3
  75. package/dist/RequiredKeyof-CHKtWddC.d.cts +0 -5
  76. package/dist/RequiredKeyof-CHKtWddC.d.ts +0 -5
  77. package/dist/chunk-3E4WCXHQ.js +0 -21
  78. package/dist/chunk-3E4WCXHQ.js.map +0 -1
  79. package/dist/chunk-3OKEPIW3.js.map +0 -1
  80. package/dist/chunk-D5FKB2PY.js.map +0 -1
  81. package/dist/chunk-ENNHXSGH.js.map +0 -1
  82. package/dist/chunk-MMV3JWIQ.js.map +0 -1
  83. package/dist/chunk-NIWB6JKL.js +0 -24
  84. package/dist/chunk-NIWB6JKL.js.map +0 -1
  85. package/dist/chunk-UVSCLLGR.js +0 -11
  86. package/dist/chunk-UVSCLLGR.js.map +0 -1
  87. package/src/utility-types/OmitKeyof.test-d.ts +0 -176
  88. package/src/utility-types/OmitKeyof.ts +0 -11
  89. package/src/utility-types/RequiredKeyof.ts +0 -3
  90. package/src/utility-types/index.ts +0 -2
  91. /package/dist/{chunk-PKNFF4OT.js.map → chunk-CLWCIHTL.js.map} +0 -0
@@ -1,131 +1,46 @@
1
- import { type QueryFunction, type UseQueryOptions, useQueries } from '@tanstack/react-query'
2
- import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery'
3
-
4
- // Avoid TS depth-limit error in case of large array literal
5
- type MAXIMUM_DEPTH = 20
6
-
7
- type GetSuspenseOptions<T> =
8
- // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }
9
- T extends {
10
- queryFnData: infer TQueryFnData
11
- error?: infer TError
12
- data: infer TData
13
- }
14
- ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>
15
- : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
16
- ? UseSuspenseQueryOptions<TQueryFnData, TError>
17
- : T extends { data: infer TData; error?: infer TError }
18
- ? UseSuspenseQueryOptions<unknown, TError, TData>
19
- : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]
20
- T extends [infer TQueryFnData, infer TError, infer TData]
21
- ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>
22
- : T extends [infer TQueryFnData, infer TError]
23
- ? UseSuspenseQueryOptions<TQueryFnData, TError>
24
- : T extends [infer TQueryFnData]
25
- ? UseSuspenseQueryOptions<TQueryFnData>
26
- : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided
27
- T extends {
28
- queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>
29
- select?: (data: any) => infer TData
30
- }
31
- ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>
32
- : T extends {
33
- queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>
34
- }
35
- ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>
36
- : // Fallback
37
- UseSuspenseQueryOptions
38
-
39
- type GetSuspenseResults<T> =
40
- // Part 1: responsible for mapping explicit type parameter to function result, if object
41
- T extends { queryFnData: any; error?: infer TError; data: infer TData }
42
- ? UseSuspenseQueryResult<TData, TError>
43
- : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
44
- ? UseSuspenseQueryResult<TQueryFnData, TError>
45
- : T extends { data: infer TData; error?: infer TError }
46
- ? UseSuspenseQueryResult<TData, TError>
47
- : // Part 2: responsible for mapping explicit type parameter to function result, if tuple
48
- T extends [any, infer TError, infer TData]
49
- ? UseSuspenseQueryResult<TData, TError>
50
- : T extends [infer TQueryFnData, infer TError]
51
- ? UseSuspenseQueryResult<TQueryFnData, TError>
52
- : T extends [infer TQueryFnData]
53
- ? UseSuspenseQueryResult<TQueryFnData>
54
- : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided
55
- T extends {
56
- queryFn?: QueryFunction<infer TQueryFnData, any>
57
- select?: (data: any) => infer TData
58
- }
59
- ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>
60
- : T extends {
61
- queryFn?: QueryFunction<infer TQueryFnData, any>
62
- }
63
- ? UseSuspenseQueryResult<TQueryFnData>
64
- : // Fallback
65
- UseSuspenseQueryResult
1
+ import {
2
+ type SuspenseQueriesOptions as original_SuspenseQueriesOptions,
3
+ type SuspenseQueriesResults as original_SuspenseQueriesResults,
4
+ useSuspenseQueries as original_useSuspenseQueries,
5
+ } from '@tanstack/react-query'
66
6
 
67
7
  /**
68
- * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
8
+ * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
9
+ * @deprecated Use `SuspenseQueriesOptions` from \@tanstack/react-query@^4.40.0
10
+ * @example
11
+ * ```diff
12
+ * - import type { SuspenseQueriesOptions } from '@suspensive/react-query'
13
+ * + import type { SuspenseQueriesOptions } from '@tanstack/react-query'
14
+ * ```
69
15
  */
70
16
  export type SuspenseQueriesOptions<
71
17
  T extends Array<any>,
72
18
  TResult extends Array<any> = [],
73
19
  TDepth extends ReadonlyArray<number> = [],
74
- > = TDepth['length'] extends MAXIMUM_DEPTH
75
- ? Array<UseSuspenseQueryOptions>
76
- : T extends []
77
- ? []
78
- : T extends [infer Head]
79
- ? [...TResult, GetSuspenseOptions<Head>]
80
- : T extends [infer Head, ...infer Tail]
81
- ? SuspenseQueriesOptions<[...Tail], [...TResult, GetSuspenseOptions<Head>], [...TDepth, 1]>
82
- : Array<unknown> extends T
83
- ? T
84
- : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
85
- // use this to infer the param types in the case of Array.map() argument
86
- T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>>
87
- ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>
88
- : // Fallback
89
- Array<UseSuspenseQueryOptions>
20
+ > = original_SuspenseQueriesOptions<T, TResult, TDepth>
90
21
 
91
22
  /**
92
- * SuspenseQueriesResults reducer recursively maps type param to results
23
+ * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
24
+ * @deprecated Use `SuspenseQueriesResults` from \@tanstack/react-query@^4.40.0
25
+ * @example
26
+ * ```diff
27
+ * - import type { SuspenseQueriesResults } from '@suspensive/react-query'
28
+ * + import type { SuspenseQueriesResults } from '@tanstack/react-query'
29
+ * ```
93
30
  */
94
31
  export type SuspenseQueriesResults<
95
32
  T extends Array<any>,
96
33
  TResult extends Array<any> = [],
97
34
  TDepth extends ReadonlyArray<number> = [],
98
- > = TDepth['length'] extends MAXIMUM_DEPTH
99
- ? Array<UseSuspenseQueryResult>
100
- : T extends []
101
- ? []
102
- : T extends [infer Head]
103
- ? [...TResult, GetSuspenseResults<Head>]
104
- : T extends [infer Head, ...infer Tail]
105
- ? SuspenseQueriesResults<[...Tail], [...TResult, GetSuspenseResults<Head>], [...TDepth, 1]>
106
- : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>>
107
- ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
108
- Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>>
109
- : // Fallback
110
- Array<UseSuspenseQueryResult>
35
+ > = original_SuspenseQueriesResults<T, TResult, TDepth>
111
36
 
112
37
  /**
113
- * This hook is wrapping `useQueries` of `@tanstack/react-query` v4 with default suspense option.
114
- * @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries Suspensive Docs}
38
+ * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
39
+ * @deprecated Use `useSuspenseQueries` from \@tanstack/react-query@^4.40.0
40
+ * @example
41
+ * ```diff
42
+ * - import { useSuspenseQueries } from '@suspensive/react-query'
43
+ * + import { useSuspenseQueries } from '@tanstack/react-query'
44
+ * ```
115
45
  */
116
- export function useSuspenseQueries<T extends any[]>({
117
- queries,
118
- context,
119
- }: {
120
- queries: readonly [...SuspenseQueriesOptions<T>]
121
- context?: UseQueryOptions['context']
122
- }): SuspenseQueriesResults<T> {
123
- return useQueries({
124
- queries: queries.map((query: typeof queries) => ({
125
- // eslint-disable-next-line @typescript-eslint/no-misused-spread
126
- ...query,
127
- suspense: true,
128
- })),
129
- context,
130
- }) as SuspenseQueriesResults<T>
131
- }
46
+ export const useSuspenseQueries = original_useSuspenseQueries
@@ -1,7 +1,6 @@
1
+ import { type UseSuspenseQueryResult, queryOptions, useSuspenseQuery } from '@tanstack/react-query'
1
2
  import { describe, expectTypeOf, it } from 'vitest'
2
- import { queryOptions } from './queryOptions'
3
3
  import { queryFn, queryKey } from './test-utils'
4
- import { type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'
5
4
 
6
5
  describe('useSuspenseQuery', () => {
7
6
  it('type check', () => {
@@ -47,12 +46,12 @@ describe('useSuspenseQuery', () => {
47
46
  const result = useSuspenseQuery({ queryKey, queryFn })
48
47
  expectTypeOf(result).toEqualTypeOf<UseSuspenseQueryResult<{ text: string }>>()
49
48
  expectTypeOf(result.data).toEqualTypeOf<{ text: string }>()
50
- expectTypeOf(result.status).toEqualTypeOf<'success'>()
49
+ expectTypeOf(result.status).toEqualTypeOf<'error' | 'success'>()
51
50
 
52
51
  const selectedResult = useSuspenseQuery({ queryKey, queryFn, select: (data) => data.text })
53
52
  expectTypeOf(selectedResult).toEqualTypeOf<UseSuspenseQueryResult<string>>()
54
53
  expectTypeOf(selectedResult.data).toEqualTypeOf<string>()
55
- expectTypeOf(selectedResult.status).toEqualTypeOf<'success'>()
54
+ expectTypeOf(selectedResult.status).toEqualTypeOf<'error' | 'success'>()
56
55
 
57
56
  const options = queryOptions({
58
57
  queryKey,
@@ -62,7 +61,7 @@ describe('useSuspenseQuery', () => {
62
61
  const resultWithOptions = useSuspenseQuery(options)
63
62
  expectTypeOf(resultWithOptions).toEqualTypeOf<UseSuspenseQueryResult<{ text: string }>>()
64
63
  expectTypeOf(resultWithOptions.data).toEqualTypeOf<{ text: string }>()
65
- expectTypeOf(resultWithOptions.status).toEqualTypeOf<'success'>()
64
+ expectTypeOf(resultWithOptions.status).toEqualTypeOf<'error' | 'success'>()
66
65
 
67
66
  const selectedResultWithOptions = useSuspenseQuery({
68
67
  ...options,
@@ -70,6 +69,6 @@ describe('useSuspenseQuery', () => {
70
69
  })
71
70
  expectTypeOf(selectedResultWithOptions).toEqualTypeOf<UseSuspenseQueryResult<string>>()
72
71
  expectTypeOf(selectedResultWithOptions.data).toEqualTypeOf<string>()
73
- expectTypeOf(selectedResultWithOptions.status).toEqualTypeOf<'success'>()
72
+ expectTypeOf(selectedResultWithOptions.status).toEqualTypeOf<'error' | 'success'>()
74
73
  })
75
74
  })
@@ -1,37 +1,38 @@
1
- import { type QueryKey, type UseQueryOptions, type UseQueryResult, useQuery } from '@tanstack/react-query'
2
- import type { OmitKeyof } from './utility-types'
1
+ import {
2
+ type UseSuspenseQueryOptions as original_UseSuspenseQueryOptions,
3
+ type UseSuspenseQueryResult as original_UseSuspenseQueryResult,
4
+ useSuspenseQuery as original_useSuspenseQuery,
5
+ } from '@tanstack/react-query'
3
6
 
4
- export interface UseSuspenseQueryResult<TData = unknown, TError = unknown>
5
- extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {
6
- data: TData
7
- status: 'success'
8
- }
7
+ /**
8
+ * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
9
+ * @deprecated Use `UseSuspenseQueryOptions` from \@tanstack/react-query@^4.40.0
10
+ * @example
11
+ * ```diff
12
+ * - import type { UseSuspenseQueryOptions } from '@suspensive/react-query'
13
+ * + import type { UseSuspenseQueryOptions } from '@tanstack/react-query'
14
+ * ```
15
+ */
16
+ export type UseSuspenseQueryOptions = original_UseSuspenseQueryOptions
9
17
 
10
- export type UseSuspenseQueryOptions<
11
- TQueryFnData = unknown,
12
- TError = unknown,
13
- TData = TQueryFnData,
14
- TQueryKey extends QueryKey = QueryKey,
15
- > = OmitKeyof<
16
- UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
17
- 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'
18
- >
18
+ /**
19
+ * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
20
+ * @deprecated Use `UseSuspenseQueryResult` from \@tanstack/react-query@^4.40.0
21
+ * @example
22
+ * ```diff
23
+ * - import type { UseSuspenseQueryResult } from '@suspensive/react-query'
24
+ * + import type { UseSuspenseQueryResult } from '@tanstack/react-query'
25
+ * ```
26
+ */
27
+ export type UseSuspenseQueryResult = original_UseSuspenseQueryResult
19
28
 
20
29
  /**
21
- * This hook is wrapping `useQuery` of `@tanstack/react-query` v4 with default suspense option.
22
- * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery Suspensive Docs}
30
+ * This feature is officially supported in \@tanstack/react-query@^4.40.0, You can proceed with the migration.
31
+ * @deprecated Use `useSuspenseQuery` from \@tanstack/react-query@^4.40.0
32
+ * @example
33
+ * ```diff
34
+ * - import { useSuspenseQuery } from '@suspensive/react-query'
35
+ * + import { useSuspenseQuery } from '@tanstack/react-query'
36
+ * ```
23
37
  */
24
- export function useSuspenseQuery<
25
- TQueryFnData = unknown,
26
- TError = unknown,
27
- TData = TQueryFnData,
28
- TQueryKey extends QueryKey = QueryKey,
29
- >(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {
30
- return useQuery<TQueryFnData, TError, TData, TQueryKey>({
31
- ...options,
32
- enabled: true,
33
- useErrorBoundary: true,
34
- suspense: true,
35
- networkMode: 'always',
36
- }) as UseSuspenseQueryResult<TData, TError>
37
- }
38
+ export const useSuspenseQuery = original_useSuspenseQuery
@@ -1,3 +0,0 @@
1
- type OmitKeyof<TObject, TKey extends TStrictly extends 'safely' ? keyof TObject | (string & Record<never, never>) | (number & Record<never, never>) | (symbol & Record<never, never>) : keyof TObject, TStrictly extends 'strictly' | 'safely' = 'strictly'> = Omit<TObject, TKey>;
2
-
3
- export type { OmitKeyof as O };
@@ -1,3 +0,0 @@
1
- type OmitKeyof<TObject, TKey extends TStrictly extends 'safely' ? keyof TObject | (string & Record<never, never>) | (number & Record<never, never>) | (symbol & Record<never, never>) : keyof TObject, TStrictly extends 'strictly' | 'safely' = 'strictly'> = Omit<TObject, TKey>;
2
-
3
- export type { OmitKeyof as O };
@@ -1,5 +0,0 @@
1
- type RequiredKeyof<T, TKey extends keyof T> = T & {
2
- [_ in TKey]: Record<never, never>;
3
- };
4
-
5
- export type { RequiredKeyof as R };
@@ -1,5 +0,0 @@
1
- type RequiredKeyof<T, TKey extends keyof T> = T & {
2
- [_ in TKey]: Record<never, never>;
3
- };
4
-
5
- export type { RequiredKeyof as R };
@@ -1,21 +0,0 @@
1
- "use client"
2
- import {
3
- __spreadProps,
4
- __spreadValues
5
- } from "./chunk-QETBZSG5.js";
6
-
7
- // src/useSuspenseQuery.ts
8
- import { useQuery } from "@tanstack/react-query";
9
- function useSuspenseQuery(options) {
10
- return useQuery(__spreadProps(__spreadValues({}, options), {
11
- enabled: true,
12
- useErrorBoundary: true,
13
- suspense: true,
14
- networkMode: "always"
15
- }));
16
- }
17
-
18
- export {
19
- useSuspenseQuery
20
- };
21
- //# sourceMappingURL=chunk-3E4WCXHQ.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/useSuspenseQuery.ts"],"sourcesContent":["import { type QueryKey, type UseQueryOptions, type UseQueryResult, useQuery } from '@tanstack/react-query'\nimport type { OmitKeyof } from './utility-types'\n\nexport interface UseSuspenseQueryResult<TData = unknown, TError = unknown>\n extends OmitKeyof<UseQueryResult<TData, TError>, keyof Pick<UseQueryResult, 'isPlaceholderData'>> {\n data: TData\n status: 'success'\n}\n\nexport type UseSuspenseQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'\n>\n\n/**\n * This hook is wrapping `useQuery` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseQuery Suspensive Docs}\n */\nexport function useSuspenseQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>) {\n return useQuery<TQueryFnData, TError, TData, TQueryKey>({\n ...options,\n enabled: true,\n useErrorBoundary: true,\n suspense: true,\n networkMode: 'always',\n }) as UseSuspenseQueryResult<TData, TError>\n}\n"],"mappings":";;;;;;;AAAA,SAAmE,gBAAgB;AAuB5E,SAAS,iBAKd,SAA0E;AAC1E,SAAO,SAAiD,iCACnD,UADmD;AAAA,IAEtD,SAAS;AAAA,IACT,kBAAkB;AAAA,IAClB,UAAU;AAAA,IACV,aAAa;AAAA,EACf,EAAC;AACH;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/infiniteQueryOptions.ts"],"sourcesContent":["import type { InfiniteData, QueryKey, UseInfiniteQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\nexport type SelectedInfiniteOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: InfiniteData<TQueryFnData>) => InfiniteData<TData>\n}\n\nexport type UnSelectedInfiniteOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\nexport function infiniteQueryOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n): SelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function infiniteQueryOptions<\n TQueryFnData,\n TError = unknown,\n TData = InfiniteData<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n): UnSelectedInfiniteOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function infiniteQueryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;AAyEO,SAAS,qBAAqB,SAAkB;AACrD,SAAO;AACT;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/SuspenseQuery.tsx"],"sourcesContent":["import type { QueryKey } from '@tanstack/react-query'\nimport type { ReactNode } from 'react'\nimport { type UseSuspenseQueryOptions, type UseSuspenseQueryResult, useSuspenseQuery } from './useSuspenseQuery'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseQuery/>` serves to make `useSuspenseQuery` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseQuery Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseQuery } from '@suspensive/react-query'\n *\n * // You can use QueryOptions as props.\n * <SuspenseQuery {...queryOptions()}>\n * {({ data, isLoading }) => {\n * return <></>\n * }\n * </SuspenseQuery>\n * ```\n */\nexport const SuspenseQuery = <\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>({\n children,\n ...options\n}: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {\n children: (queryResult: UseSuspenseQueryResult<TData, TError>) => ReactNode\n}) => <>{children(useSuspenseQuery(options))}</>\n"],"mappings":";;;;;;;;;AA8BM;AAVC,IAAM,gBAAgB,CAK3B,OAKC;AALD,eACA;AAAA;AAAA,EA1BF,IAyBE,IAEG,oBAFH,IAEG;AAAA,IADH;AAAA;AAII,yCAAG,mBAAS,iBAAiB,OAAO,CAAC,GAAE;AAAA;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/useSuspenseInfiniteQuery.ts"],"sourcesContent":["import {\n type InfiniteData,\n type QueryKey,\n type UseInfiniteQueryOptions,\n type UseInfiniteQueryResult,\n useInfiniteQuery,\n} from '@tanstack/react-query'\nimport type { OmitKeyof } from './utility-types'\n\nexport interface UseSuspenseInfiniteQueryResult<TData = unknown, TError = unknown>\n extends OmitKeyof<\n UseInfiniteQueryResult<TData, TError>,\n keyof Pick<UseInfiniteQueryResult<TData, TError>, 'isPlaceholderData'>\n > {\n data: InfiniteData<TData>\n status: 'success'\n}\n\nexport type UseSuspenseInfiniteQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = OmitKeyof<\n UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,\n 'suspense' | 'useErrorBoundary' | 'enabled' | 'placeholderData' | 'networkMode'\n>\n\n/**\n * This hook is wrapping `useInfiniteQuery` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery Suspensive Docs}\n */\nexport function useSuspenseInfiniteQuery<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): UseSuspenseInfiniteQueryResult<TData, TError> {\n return useInfiniteQuery({\n ...options,\n enabled: true,\n suspense: true,\n useErrorBoundary: true,\n networkMode: 'always',\n }) as UseSuspenseInfiniteQueryResult<TData, TError>\n}\n"],"mappings":";;;;;;;AAAA;AAAA,EAKE;AAAA,OACK;AA0BA,SAAS,yBAMd,SAC+C;AAC/C,SAAO,iBAAiB,iCACnB,UADmB;AAAA,IAEtB,SAAS;AAAA,IACT,UAAU;AAAA,IACV,kBAAkB;AAAA,IAClB,aAAa;AAAA,EACf,EAAC;AACH;","names":[]}
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/SuspenseQueries.tsx"],"sourcesContent":["import type { ReactNode } from 'react'\nimport { type SuspenseQueriesOptions, type SuspenseQueriesResults, useSuspenseQueries } from './useSuspenseQueries'\n\n/**\n * We provide these components to clearly express what causes suspense at the same depth.\n * `<SuspenseQueries/>` serves to make `useSuspenseQueries` easier to use in jsx.\n * @see {@link https://suspensive.org/docs/react-query/SuspenseQueries Suspensive Docs}\n * @example\n * ```tsx\n * import { SuspenseQueries } from '@suspensive/react-query'\n *\n * <SuspenseQueries queries={[firstQueryOptions(), secondQueryOptions()]}>\n * {([{ data: firstQueryData }, { data: secondQueryData }]) => {\n * return <></>\n * }}\n * </SuspenseQueries>\n * ```\n */\nexport function SuspenseQueries<T extends any[]>({\n children,\n queries,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n children: (queries: SuspenseQueriesResults<T>) => ReactNode\n}) {\n return <>{children(useSuspenseQueries({ queries }))}</>\n}\n"],"mappings":";;;;;;AAyBS;AAPF,SAAS,gBAAiC;AAAA,EAC/C;AAAA,EACA;AACF,GAGG;AACD,SAAO,gCAAG,mBAAS,mBAAmB,EAAE,QAAQ,CAAC,CAAC,GAAE;AACtD;","names":[]}
@@ -1,24 +0,0 @@
1
- "use client"
2
- import {
3
- __spreadProps,
4
- __spreadValues
5
- } from "./chunk-QETBZSG5.js";
6
-
7
- // src/useSuspenseQueries.ts
8
- import { useQueries } from "@tanstack/react-query";
9
- function useSuspenseQueries({
10
- queries,
11
- context
12
- }) {
13
- return useQueries({
14
- queries: queries.map((query) => __spreadProps(__spreadValues({}, query), {
15
- suspense: true
16
- })),
17
- context
18
- });
19
- }
20
-
21
- export {
22
- useSuspenseQueries
23
- };
24
- //# sourceMappingURL=chunk-NIWB6JKL.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/useSuspenseQueries.ts"],"sourcesContent":["import { type QueryFunction, type UseQueryOptions, useQueries } from '@tanstack/react-query'\nimport type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery'\n\n// Avoid TS depth-limit error in case of large array literal\ntype MAXIMUM_DEPTH = 20\n\ntype GetSuspenseOptions<T> =\n // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }\n T extends {\n queryFnData: infer TQueryFnData\n error?: infer TError\n data: infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryOptions<unknown, TError, TData>\n : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]\n T extends [infer TQueryFnData, infer TError, infer TData]\n ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryOptions<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryOptions<TQueryFnData>\n : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>\n }\n ? UseSuspenseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>\n : // Fallback\n UseSuspenseQueryOptions\n\ntype GetSuspenseResults<T> =\n // Part 1: responsible for mapping explicit type parameter to function result, if object\n T extends { queryFnData: any; error?: infer TError; data: infer TData }\n ? UseSuspenseQueryResult<TData, TError>\n : T extends { queryFnData: infer TQueryFnData; error?: infer TError }\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends { data: infer TData; error?: infer TError }\n ? UseSuspenseQueryResult<TData, TError>\n : // Part 2: responsible for mapping explicit type parameter to function result, if tuple\n T extends [any, infer TError, infer TData]\n ? UseSuspenseQueryResult<TData, TError>\n : T extends [infer TQueryFnData, infer TError]\n ? UseSuspenseQueryResult<TQueryFnData, TError>\n : T extends [infer TQueryFnData]\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided\n T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n select?: (data: any) => infer TData\n }\n ? UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData>\n : T extends {\n queryFn?: QueryFunction<infer TQueryFnData, any>\n }\n ? UseSuspenseQueryResult<TQueryFnData>\n : // Fallback\n UseSuspenseQueryResult\n\n/**\n * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param\n */\nexport type SuspenseQueriesOptions<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryOptions>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseOptions<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesOptions<[...Tail], [...TResult, GetSuspenseOptions<Head>], [...TDepth, 1]>\n : Array<unknown> extends T\n ? T\n : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!\n // use this to infer the param types in the case of Array.map() argument\n T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>>\n ? Array<UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>>\n : // Fallback\n Array<UseSuspenseQueryOptions>\n\n/**\n * SuspenseQueriesResults reducer recursively maps type param to results\n */\nexport type SuspenseQueriesResults<\n T extends Array<any>,\n TResult extends Array<any> = [],\n TDepth extends ReadonlyArray<number> = [],\n> = TDepth['length'] extends MAXIMUM_DEPTH\n ? Array<UseSuspenseQueryResult>\n : T extends []\n ? []\n : T extends [infer Head]\n ? [...TResult, GetSuspenseResults<Head>]\n : T extends [infer Head, ...infer Tail]\n ? SuspenseQueriesResults<[...Tail], [...TResult, GetSuspenseResults<Head>], [...TDepth, 1]>\n : T extends Array<UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, any>>\n ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results\n Array<UseSuspenseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>>\n : // Fallback\n Array<UseSuspenseQueryResult>\n\n/**\n * This hook is wrapping `useQueries` of `@tanstack/react-query` v4 with default suspense option.\n * @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries Suspensive Docs}\n */\nexport function useSuspenseQueries<T extends any[]>({\n queries,\n context,\n}: {\n queries: readonly [...SuspenseQueriesOptions<T>]\n context?: UseQueryOptions['context']\n}): SuspenseQueriesResults<T> {\n return useQueries({\n queries: queries.map((query: typeof queries) => ({\n // eslint-disable-next-line @typescript-eslint/no-misused-spread\n ...query,\n suspense: true,\n })),\n context,\n }) as SuspenseQueriesResults<T>\n}\n"],"mappings":";;;;;;;AAAA,SAAmD,kBAAkB;AAmH9D,SAAS,mBAAoC;AAAA,EAClD;AAAA,EACA;AACF,GAG8B;AAC5B,SAAO,WAAW;AAAA,IAChB,SAAS,QAAQ,IAAI,CAAC,UAA2B,iCAE5C,QAF4C;AAAA,MAG/C,UAAU;AAAA,IACZ,EAAE;AAAA,IACF;AAAA,EACF,CAAC;AACH;","names":[]}
@@ -1,11 +0,0 @@
1
- "use client"
2
-
3
- // src/queryOptions.ts
4
- function queryOptions(options) {
5
- return options;
6
- }
7
-
8
- export {
9
- queryOptions
10
- };
11
- //# sourceMappingURL=chunk-UVSCLLGR.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/queryOptions.ts"],"sourcesContent":["import type { QueryKey, UseQueryOptions } from '@tanstack/react-query'\nimport type { OmitKeyof, RequiredKeyof } from './utility-types'\n\nexport type SelectedQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'getNextPageParam'\n | 'getPreviousPageParam'\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select: (data: TQueryFnData) => TData\n}\n\nexport type UnSelectedQueryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n> = RequiredKeyof<\n OmitKeyof<\n UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,\n | 'getNextPageParam'\n | 'getPreviousPageParam'\n | 'queryKeyHashFn'\n | '_defaulted'\n | 'behavior'\n | 'structuralSharing'\n | 'isDataEqual'\n | 'onSuccess'\n | 'onError'\n | 'onSettled'\n | 'enabled'\n | 'refetchInterval'\n | 'initialData'\n | 'networkMode'\n >,\n 'queryKey' | 'queryFn'\n> & {\n select?: undefined\n}\n\n/**\n * Creates a reusable query options object that can be used across different query hooks.\n * Provides better type inference and easier query key management.\n *\n * @see {@link https://suspensive.org/docs/react-query/queryOptions Suspensive Docs}\n */\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): SelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function queryOptions<\n TQueryFnData = unknown,\n TError = unknown,\n TData = TQueryFnData,\n TQueryKey extends QueryKey = QueryKey,\n>(\n options: UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n): UnSelectedQueryOptions<TQueryFnData, TError, TData, TQueryKey>\n\nexport function queryOptions(options: unknown) {\n return options\n}\n"],"mappings":";;;AAmFO,SAAS,aAAa,SAAkB;AAC7C,SAAO;AACT;","names":[]}
@@ -1,176 +0,0 @@
1
- import type { OmitKeyof } from './OmitKeyof'
2
-
3
- describe('OmitKeyof', () => {
4
- it("'s string key type check", () => {
5
- type A = {
6
- x: string
7
- y: number
8
- }
9
-
10
- type ExpectedType = {
11
- x: string
12
- }
13
-
14
- // Bad point
15
- // 1. original Omit can use 'z' as type parameter with no type error
16
- // 2. original Omit have no auto complete for 2nd type parameter
17
- expectTypeOf<Omit<A, 'z' | 'y'>>().toEqualTypeOf<ExpectedType>()
18
-
19
- // Solution
20
-
21
- // 1. strictly
22
- expectTypeOf<
23
- OmitKeyof<
24
- A,
25
- // OmitKeyof can't use 'z' as type parameter with type error because A don't have key 'z'
26
- // @ts-expect-error Type does not satisfy the constraint keyof A
27
- 'z' | 'y'
28
- >
29
- >().toEqualTypeOf<ExpectedType>()
30
- expectTypeOf<
31
- OmitKeyof<
32
- A,
33
- // OmitKeyof can't use 'z' as type parameter with type error because A don't have key 'z'
34
- // @ts-expect-error Type does not satisfy the constraint keyof A
35
- 'z' | 'y',
36
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
37
- 'strictly'
38
- >
39
- >().toEqualTypeOf<ExpectedType>()
40
-
41
- // 2. safely
42
- expectTypeOf<
43
- OmitKeyof<
44
- A,
45
- // OmitKeyof can't use 'z' as type parameter type error with strictly parameter or default parameter
46
- // @ts-expect-error Type does not satisfy the constraint keyof A
47
- 'z' | 'y'
48
- >
49
- >().toEqualTypeOf<ExpectedType>()
50
- expectTypeOf<
51
- OmitKeyof<
52
- A,
53
- // With 'safely', OmitKeyof can use 'z' as type parameter like original Omit but This support autocomplete too yet for DX.
54
- 'z' | 'y',
55
- 'safely'
56
- >
57
- >().toEqualTypeOf<ExpectedType>()
58
- })
59
-
60
- it("'s number key type check", () => {
61
- type A = {
62
- [1]: string
63
- [2]: number
64
- }
65
-
66
- type ExpectedType = {
67
- [1]: string
68
- }
69
-
70
- // Bad point
71
- // 1. original Omit can use 3 as type parameter with no type error
72
- // 2. original Omit have no auto complete for 2nd type parameter
73
- expectTypeOf<Omit<A, 3 | 2>>().toEqualTypeOf<ExpectedType>()
74
-
75
- // Solution
76
-
77
- // 1. strictly
78
- expectTypeOf<
79
- OmitKeyof<
80
- A,
81
- // OmitKeyof can't use 3 as type parameter with type error because A don't have key 3
82
- // @ts-expect-error Type does not satisfy the constraint keyof A
83
- 3 | 2
84
- >
85
- >().toEqualTypeOf<ExpectedType>()
86
- expectTypeOf<
87
- OmitKeyof<
88
- A,
89
- // OmitKeyof can't use 3 as type parameter with type error because A don't have key 3
90
- // @ts-expect-error Type does not satisfy the constraint keyof A
91
- 3 | 2,
92
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
93
- 'strictly'
94
- >
95
- >().toEqualTypeOf<ExpectedType>()
96
-
97
- // 2. safely
98
- expectTypeOf<
99
- OmitKeyof<
100
- A,
101
- // OmitKeyof can't use 3 as type parameter type error with strictly parameter or default parameter
102
- // @ts-expect-error Type does not satisfy the constraint keyof A
103
- 3 | 2
104
- >
105
- >().toEqualTypeOf<ExpectedType>()
106
- expectTypeOf<
107
- OmitKeyof<
108
- A,
109
- // With 'safely', OmitKeyof can use 3 as type parameter like original Omit but This support autocomplete too yet for DX.
110
- 3 | 2,
111
- 'safely'
112
- >
113
- >().toEqualTypeOf<ExpectedType>()
114
- })
115
-
116
- it("'s symbol key type check", () => {
117
- const symbol1 = Symbol()
118
- const symbol2 = Symbol()
119
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
120
- const symbol3 = Symbol()
121
-
122
- type A = {
123
- [symbol1]: string
124
- [symbol2]: number
125
- }
126
-
127
- type ExpectedType = {
128
- [symbol1]: string
129
- }
130
-
131
- // Bad point
132
- // 1. original Omit can use symbol3 as type parameter with no type error
133
- // 2. original Omit have no auto complete for 2nd type parameter
134
- expectTypeOf<Omit<A, typeof symbol3 | typeof symbol2>>().toEqualTypeOf<ExpectedType>()
135
-
136
- // Solution
137
-
138
- // 1. strictly
139
- expectTypeOf<
140
- OmitKeyof<
141
- A,
142
- // OmitKeyof can't use symbol3 as type parameter with type error because A don't have key symbol3
143
- // @ts-expect-error Type does not satisfy the constraint keyof A
144
- typeof symbol3 | typeof symbol2
145
- >
146
- >().toEqualTypeOf<ExpectedType>()
147
- expectTypeOf<
148
- OmitKeyof<
149
- A,
150
- // OmitKeyof can't use symbol3 as type parameter with type error because A don't have key symbol3
151
- // @ts-expect-error Type does not satisfy the constraint keyof A
152
- typeof symbol3 | typeof symbol2,
153
- // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments
154
- 'strictly'
155
- >
156
- >().toEqualTypeOf<ExpectedType>()
157
-
158
- // 2. safely
159
- expectTypeOf<
160
- OmitKeyof<
161
- A,
162
- // OmitKeyof can't use symbol3 as type parameter type error with strictly parameter or default parameter
163
- // @ts-expect-error Type does not satisfy the constraint keyof A
164
- typeof symbol3 | typeof symbol2
165
- >
166
- >().toEqualTypeOf<ExpectedType>()
167
- expectTypeOf<
168
- OmitKeyof<
169
- A,
170
- // With 'safely', OmitKeyof can use symbol3 as type parameter like original Omit but This support autocomplete too yet for DX.
171
- typeof symbol3 | typeof symbol2,
172
- 'safely'
173
- >
174
- >().toEqualTypeOf<ExpectedType>()
175
- })
176
- })
@@ -1,11 +0,0 @@
1
- export type OmitKeyof<
2
- TObject,
3
- TKey extends TStrictly extends 'safely'
4
- ?
5
- | keyof TObject
6
- | (string & Record<never, never>)
7
- | (number & Record<never, never>)
8
- | (symbol & Record<never, never>)
9
- : keyof TObject,
10
- TStrictly extends 'strictly' | 'safely' = 'strictly',
11
- > = Omit<TObject, TKey>
@@ -1,3 +0,0 @@
1
- export type RequiredKeyof<T, TKey extends keyof T> = T & {
2
- [_ in TKey]: Record<never, never>
3
- }
@@ -1,2 +0,0 @@
1
- export type { OmitKeyof } from './OmitKeyof'
2
- export type { RequiredKeyof } from './RequiredKeyof'