Skip to main content

@gqless/react#

Table of contents#

Interfaces#

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:#

NameType
errorgqlessError

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:#

NameTypeDefault
TRecord<string | number, unknown>{}

Defined in: react/src/ssr/ssr.ts:25


UseQueryReturnValue#

Ƭ UseQueryReturnValue<GeneratedSchema>: GeneratedSchema[query] & { $state: UseQueryState }

Type parameters:#

NameType
GeneratedSchemaobject
GeneratedSchema.queryobject

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:#

NameType
GeneratedSchemaobject
GeneratedSchema.mutationobject
GeneratedSchema.queryobject
GeneratedSchema.subscriptionobject

Parameters:#

NameTypeDefault value
clientGqlessClient<GeneratedSchema>-
optsCreateCreateReactClientOptions{}

Returns: ReactClient<GeneratedSchema>

Defined in: react/src/client.ts:183

Last updated on by Sam Denty