Skip to content

Commit a99da02

Browse files
committed
refactor(solid-query): remove 'Solid' prefix from 'SolidQueryOptions', 'SolidInfiniteQueryOptions', and 'SolidMutationOptions'
1 parent 7ffa1ed commit a99da02

File tree

9 files changed

+32
-32
lines changed

9 files changed

+32
-32
lines changed

packages/solid-query/src/__tests__/mutationOptions.test-d.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type {
99
MutationState,
1010
WithRequired,
1111
} from '@tanstack/query-core'
12-
import type { SolidMutationOptions, UseMutationResult } from '../types'
12+
import type { MutationOptions, UseMutationResult } from '../types'
1313

1414
describe('mutationOptions', () => {
1515
it('should not allow excess properties', () => {
@@ -120,7 +120,7 @@ describe('mutationOptions', () => {
120120
}),
121121
).toEqualTypeOf<
122122
WithRequired<
123-
SolidMutationOptions<number, DefaultError, string>,
123+
MutationOptions<number, DefaultError, string>,
124124
'mutationKey'
125125
>
126126
>()
@@ -132,7 +132,7 @@ describe('mutationOptions', () => {
132132
},
133133
}),
134134
).toEqualTypeOf<
135-
Omit<SolidMutationOptions<number, DefaultError, string>, 'mutationKey'>
135+
Omit<MutationOptions<number, DefaultError, string>, 'mutationKey'>
136136
>()
137137
})
138138

packages/solid-query/src/__tests__/useQueries.test-d.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { queryOptions, useQueries } from '..'
55
import { QueryClient } from '../QueryClient'
66
import type { OmitKeyof } from '@tanstack/query-core'
77
import type { UseQueryResult } from '..'
8-
import type { SolidQueryOptions } from '../types'
8+
import type { QueryOptions } from '../types'
99

1010
describe('useQueries', () => {
1111
it('TData should have undefined in the union even when initialData is provided as an object', () => {
@@ -164,11 +164,11 @@ describe('useQueries', () => {
164164
})
165165

166166
describe('custom hook', () => {
167-
it('should allow custom hooks using SolidQueryOptions', () => {
167+
it('should allow custom hooks using QueryOptions', () => {
168168
type Data = string
169169

170170
const useCustomQueries = (
171-
options?: OmitKeyof<SolidQueryOptions<Data>, 'queryKey' | 'queryFn'>,
171+
options?: OmitKeyof<QueryOptions<Data>, 'queryKey' | 'queryFn'>,
172172
) => {
173173
return useQueries(() => ({
174174
queries: [

packages/solid-query/src/__tests__/useQueries.test.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import type {
2222
QueryFunction,
2323
QueryFunctionContext,
2424
QueryKey,
25-
SolidQueryOptions,
25+
QueryOptions,
2626
UseQueryResult,
2727
} from '..'
2828

@@ -586,7 +586,7 @@ describe('useQueries', () => {
586586
TData,
587587
TQueryKey extends QueryKey,
588588
>(
589-
queries: Array<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
589+
queries: Array<QueryOptions<TQueryFnData, TError, TData, TQueryKey>>,
590590
) {
591591
return useQueries(() => ({
592592
queries: queries.map(

packages/solid-query/src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ export type {
1515
DefinedUseBaseQueryResult,
1616
DefinedUseInfiniteQueryResult,
1717
DefinedUseQueryResult,
18-
SolidInfiniteQueryOptions,
19-
SolidMutationOptions,
20-
SolidQueryOptions,
18+
InfiniteQueryOptions,
19+
MutationOptions,
20+
QueryOptions,
2121
UseBaseMutationResult,
2222
UseBaseQueryOptions,
2323
UseBaseQueryResult,

packages/solid-query/src/infiniteQueryOptions.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import type {
55
NonUndefinedGuard,
66
QueryKey,
77
} from '@tanstack/query-core'
8-
import type { SolidInfiniteQueryOptions } from './types'
8+
import type { InfiniteQueryOptions } from './types'
99
import type { Accessor } from 'solid-js'
1010

1111
export type UndefinedInitialDataInfiniteOptions<
@@ -15,7 +15,7 @@ export type UndefinedInitialDataInfiniteOptions<
1515
TQueryKey extends QueryKey = QueryKey,
1616
TPageParam = unknown,
1717
> = Accessor<
18-
SolidInfiniteQueryOptions<
18+
InfiniteQueryOptions<
1919
TQueryFnData,
2020
TError,
2121
TData,
@@ -34,7 +34,7 @@ export type DefinedInitialDataInfiniteOptions<
3434
TQueryKey extends QueryKey = QueryKey,
3535
TPageParam = unknown,
3636
> = Accessor<
37-
SolidInfiniteQueryOptions<
37+
InfiniteQueryOptions<
3838
TQueryFnData,
3939
TError,
4040
TData,
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { DefaultError, WithRequired } from '@tanstack/query-core'
2-
import type { SolidMutationOptions } from './types'
2+
import type { MutationOptions } from './types'
33

44
export function mutationOptions<
55
TData = unknown,
@@ -8,11 +8,11 @@ export function mutationOptions<
88
TOnMutateResult = unknown,
99
>(
1010
options: WithRequired<
11-
SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
11+
MutationOptions<TData, TError, TVariables, TOnMutateResult>,
1212
'mutationKey'
1313
>,
1414
): WithRequired<
15-
SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
15+
MutationOptions<TData, TError, TVariables, TOnMutateResult>,
1616
'mutationKey'
1717
>
1818
export function mutationOptions<
@@ -22,11 +22,11 @@ export function mutationOptions<
2222
TOnMutateResult = unknown,
2323
>(
2424
options: Omit<
25-
SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
25+
MutationOptions<TData, TError, TVariables, TOnMutateResult>,
2626
'mutationKey'
2727
>,
2828
): Omit<
29-
SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
29+
MutationOptions<TData, TError, TVariables, TOnMutateResult>,
3030
'mutationKey'
3131
>
3232
export function mutationOptions<
@@ -35,7 +35,7 @@ export function mutationOptions<
3535
TVariables = void,
3636
TOnMutateResult = unknown,
3737
>(
38-
options: SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>,
39-
): SolidMutationOptions<TData, TError, TVariables, TOnMutateResult> {
38+
options: MutationOptions<TData, TError, TVariables, TOnMutateResult>,
39+
): MutationOptions<TData, TError, TVariables, TOnMutateResult> {
4040
return options
4141
}

packages/solid-query/src/queryOptions.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import type { DataTag, DefaultError, QueryKey } from '@tanstack/query-core'
2-
import type { SolidQueryOptions } from './types'
2+
import type { QueryOptions } from './types'
33
import type { Accessor } from 'solid-js'
44

55
export type UndefinedInitialDataOptions<
@@ -8,7 +8,7 @@ export type UndefinedInitialDataOptions<
88
TData = TQueryFnData,
99
TQueryKey extends QueryKey = QueryKey,
1010
> = Accessor<
11-
SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
11+
QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
1212
initialData?: undefined
1313
}
1414
>
@@ -19,7 +19,7 @@ export type DefinedInitialDataOptions<
1919
TData = TQueryFnData,
2020
TQueryKey extends QueryKey = QueryKey,
2121
> = Accessor<
22-
SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
22+
QueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
2323
initialData: TQueryFnData | (() => TQueryFnData)
2424
}
2525
>

packages/solid-query/src/types.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface UseBaseQueryOptions<
4444
suspense?: boolean
4545
}
4646

47-
export interface SolidQueryOptions<
47+
export interface QueryOptions<
4848
TQueryFnData = unknown,
4949
TError = DefaultError,
5050
TData = TQueryFnData,
@@ -62,7 +62,7 @@ export type UseQueryOptions<
6262
TError = DefaultError,
6363
TData = TQueryFnData,
6464
TQueryKey extends QueryKey = QueryKey,
65-
> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>
65+
> = Accessor<QueryOptions<TQueryFnData, TError, TData, TQueryKey>>
6666

6767
/* --- Create Query and Create Base Query Types --- */
6868

@@ -87,7 +87,7 @@ export type DefinedUseQueryResult<
8787
> = DefinedUseBaseQueryResult<TData, TError>
8888

8989
/* --- Create Infinite Queries Types --- */
90-
export interface SolidInfiniteQueryOptions<
90+
export interface InfiniteQueryOptions<
9191
TQueryFnData = unknown,
9292
TError = DefaultError,
9393
TData = TQueryFnData,
@@ -126,7 +126,7 @@ export type UseInfiniteQueryOptions<
126126
TQueryKey extends QueryKey = QueryKey,
127127
TPageParam = unknown,
128128
> = Accessor<
129-
SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
129+
InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
130130
>
131131

132132
export type UseInfiniteQueryResult<
@@ -140,7 +140,7 @@ export type DefinedUseInfiniteQueryResult<
140140
> = DefinedInfiniteQueryObserverResult<TData, TError>
141141

142142
/* --- Create Mutation Types --- */
143-
export interface SolidMutationOptions<
143+
export interface MutationOptions<
144144
TData = unknown,
145145
TError = DefaultError,
146146
TVariables = void,
@@ -155,7 +155,7 @@ export type UseMutationOptions<
155155
TError = DefaultError,
156156
TVariables = void,
157157
TOnMutateResult = unknown,
158-
> = Accessor<SolidMutationOptions<TData, TError, TVariables, TOnMutateResult>>
158+
> = Accessor<MutationOptions<TData, TError, TVariables, TOnMutateResult>>
159159

160160
export type UseMutateFunction<
161161
TData = unknown,

packages/solid-query/src/useQueries.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import {
1313
} from 'solid-js'
1414
import { useQueryClient } from './QueryClientProvider'
1515
import { useIsRestoring } from './isRestoring'
16-
import type { SolidQueryOptions, UseQueryResult } from './types'
16+
import type { QueryOptions, UseQueryResult } from './types'
1717
import type { Accessor } from 'solid-js'
1818
import type { QueryClient } from './QueryClient'
1919
import type {
@@ -36,7 +36,7 @@ type UseQueryOptionsForUseQueries<
3636
TData = TQueryFnData,
3737
TQueryKey extends QueryKey = QueryKey,
3838
> = OmitKeyof<
39-
SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
39+
QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
4040
'placeholderData' | 'suspense'
4141
> & {
4242
placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>

0 commit comments

Comments
 (0)