@gqless/react#
Table of contents#
Interfaces#
- CoreHelpers
- CreateReactClientOptions
- FetchMoreCallbackArgs
- GraphQLHOC
- GraphQLHOCOptions
- MetaState
- PrepareQuery
- PrepareReactRender
- PreparedQuery
- ReactClient
- ReactClientDefaults
- UseHydrateCache
- UseHydrateCacheOptions
- UseLazyQuery
- UseLazyQueryOptions
- UseLazyQueryState
- UseMetaState
- UseMetaStateOptions
- UseMutation
- UseMutationOptions
- UseMutationState
- UsePaginatedQuery
- UsePaginatedQueryData
- UsePaginatedQueryMergeParams
- UsePaginatedQueryOptions
- UsePreparedQueryOptions
- UseQuery
- UseQueryOptions
- UseQueryState
- UseRefetch
- UseRefetchOptions
- UseRefetchState
- UseSubscription
- UseTransactionQuery
- UseTransactionQueryState
References#
sortBy#
Renames and exports: __type
uniqBy#
Renames and exports: __type
Type aliases#
FetchPolicy#
Ƭ FetchPolicy: cache-and-network | cache-first | network-only | no-cache
Defined in: react/src/common.ts:152
LazyFetchPolicy#
Ƭ LazyFetchPolicy: Exclude<FetchPolicy, cache-first>
Defined in: react/src/query/useLazyQuery.ts:13
OnErrorHandler#
Ƭ OnErrorHandler: (error: gqlessError) => void
Type declaration:#
â–¸ (error: gqlessError): void
Parameters:#
| Name | Type |
|---|---|
error | gqlessError |
Returns: void
Defined in: react/src/common.ts:513
PaginatedQueryFetchPolicy#
Ƭ PaginatedQueryFetchPolicy: Extract<FetchPolicy, cache-first | cache-and-network | network-only>
Defined in: react/src/query/usePaginatedQuery.ts:16
PropsWithServerCache#
Ƭ PropsWithServerCache<T>: { cacheSnapshot?: string } & T
Props with cacheSnapshot that would be returned from prepareReactRender
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | Record<string | number, unknown> | {} |
Defined in: react/src/ssr/ssr.ts:25
UseQueryReturnValue#
Ƭ UseQueryReturnValue<GeneratedSchema>: GeneratedSchema[query] & { $state: UseQueryState }
Type parameters:#
| Name | Type |
|---|---|
GeneratedSchema | object |
GeneratedSchema.query | object |
Defined in: react/src/query/useQuery.ts:37
UseTransactionQueryOptions#
Ƭ UseTransactionQueryOptions<TData, TVariables>: { fetchPolicy?: FetchPolicy ; notifyOnNetworkStatusChange?: boolean ; onCompleted?: (data: TData) => void ; onError?: OnErrorHandler ; pollInterval?: number ; retry?: RetryOptions ; skip?: boolean ; suspense?: boolean ; variables?: TVariables } & TVariables extends undefined ? { variables?: TVariables } : { variables: TVariables }
Type parameters:#
| Name |
|---|
TData |
TVariables |
Defined in: react/src/query/useTransactionQuery.ts:106
Variables#
coreHelpers#
• Const coreHelpers: CoreHelpers
Defined in: react/src/common.ts:524
Functions#
createReactClient#
â–¸ createReactClient<GeneratedSchema>(client: GqlessClient<GeneratedSchema>, optsCreate?: CreateReactClientOptions): ReactClient<GeneratedSchema>
Type parameters:#
| Name | Type |
|---|---|
GeneratedSchema | object |
GeneratedSchema.mutation | object |
GeneratedSchema.query | object |
GeneratedSchema.subscription | object |
Parameters:#
| Name | Type | Default value |
|---|---|---|
client | GqlessClient<GeneratedSchema> | - |
optsCreate | CreateReactClientOptions | {} |
Returns: ReactClient<GeneratedSchema>
Defined in: react/src/client.ts:183