Interface: PreparedQuery<GeneratedSchema, TFunction>#
Type parameters#
| Name | Type |
|---|---|
GeneratedSchema | object |
GeneratedSchema.query | object |
TFunction | (query: GeneratedSchema[query], args: any) => any |
Properties#
callback#
• callback: TFunction
Defined in: react/src/query/preparedQuery.ts:40
Methods#
preload#
â–¸ preload(...__namedParameters: undefined extends Parameters<TFunction>[1] ? [Parameters<TFunction>["1"]?] : [Parameters<TFunction>[1]]): Promise<ReturnType<TFunction>>
Parameters:#
| Name | Type |
|---|---|
...__namedParameters | undefined extends Parameters<TFunction>[1] ? [Parameters<TFunction>["1"]?] : [Parameters<TFunction>[1]] |
Returns: Promise<ReturnType<TFunction>>
Defined in: react/src/query/preparedQuery.ts:21
refetch#
â–¸ refetch(...__namedParameters: undefined extends Parameters<TFunction>[1] ? [Parameters<TFunction>["1"]?] : [Parameters<TFunction>[1]]): Promise<ReturnType<TFunction>>
Parameters:#
| Name | Type |
|---|---|
...__namedParameters | undefined extends Parameters<TFunction>[1] ? [Parameters<TFunction>["1"]?] : [Parameters<TFunction>[1]] |
Returns: Promise<ReturnType<TFunction>>
Defined in: react/src/query/preparedQuery.ts:26
usePrepared#
â–¸ usePrepared(opts?: UsePreparedQueryOptions): object
Parameters:#
| Name | Type |
|---|---|
opts? | UsePreparedQueryOptions |
Returns: object
| Name | Type |
|---|---|
called | boolean |
data | undefined | ReturnType<TFunction> |
error? | gqlessError |
isLoading | boolean |
isRefetching | boolean |
Defined in: react/src/query/preparedQuery.ts:31