gqless#
Table of contents#
Enumerations#
Classes#
Interfaces#
- AccessorCache
- AssignSelections
- BuildAndFetchSelections
- BuildSelection
- ClientOptions
- GqlessClient
- HydrateCache
- HydrateCacheOptions
- InnerClientState
- InterceptorManager
- Mutate
- MutateHelpers
- ParseSchemaTypeInfo
- Prefetch
- PrepareRender
- PrepassObjKey
- Refetch
- ResolveOptions
- Resolved
- Resolvers
- RetryConfigState
- Scalars
- Scheduler
- Schema
- SelectionManager
- SetCache
- SubscribeEvents
- SubscriptionsClient
- Type
Type aliases#
BuildSelectionInput#
Ƭ BuildSelectionInput: [query | mutation | subscription, ...BuildSelectionValue[]]
Defined in: packages/gqless/src/Selection/SelectionBuilder.ts:12
BuildSelectionValue#
Ƭ BuildSelectionValue: string | number | [string | number, object?]
Defined in: packages/gqless/src/Selection/SelectionBuilder.ts:8
CacheType#
Ƭ CacheType: Record<string, unknown>
Defined in: packages/gqless/src/Cache/dataCache.ts:8
DeepPartial#
Ƭ DeepPartial<T>: T extends Function ? T : T extends infer U[] ? _DeepPartialArray<U> : T extends object ? _DeepPartialObject<T> : T | undefined
Type parameters:#
| Name |
|---|
T |
Defined in: packages/gqless/src/Schema/types.ts:64
NotSkeleton#
Ƭ NotSkeleton<T>: T extends any[] ? NotSkeleton<T[number]>[] : T extends (...args: any[]) => any ? (...args: Parameters<T>) => NotUndefined<ReturnType<T>> : T extends object ? { [P in keyof T]: NotUndefined<T[P]>} : NotUndefined<T>
Remove all possible 'undefined' types in the first level.
Type parameters:#
| Name |
|---|
T |
Defined in: packages/gqless/src/Helpers/casters.ts:19
NotSkeletonDeep#
Ƭ NotSkeletonDeep<T>: T extends any[] ? NotUndefined<NotSkeletonDeep<T[number]>>[] : T extends (...args: any[]) => any ? (...args: Parameters<T>) => NotSkeletonDeep<NotUndefined<ReturnType<T>>> : T extends object ? { [P in keyof T]: NotUndefined<NotSkeletonDeep<T[P]>>} : NotUndefined<T>
Remove all possible 'undefined' values recursively from an object
Type parameters:#
| Name |
|---|
T |
Defined in: packages/gqless/src/Helpers/casters.ts:6
NotUndefined#
Ƭ NotUndefined<T>: T extends undefined ? never : T
Type parameters:#
| Name |
|---|
T |
Defined in: packages/gqless/src/Helpers/casters.ts:1
PossiblePromise#
Ƭ PossiblePromise<T>: Promise<T> | T
Type parameters:#
| Name |
|---|
T |
Defined in: packages/gqless/src/Client/client.ts:75
QueryFetcher#
Ƭ QueryFetcher: (query: string, variables?: Record<string, any>) => Promise<ExecutionResult> | ExecutionResult
Type declaration:#
â–¸ (query: string, variables?: Record<string, any>): Promise<ExecutionResult> | ExecutionResult
Parameters:#
| Name | Type |
|---|---|
query | string |
variables? | Record<string, any> |
Returns: Promise<ExecutionResult> | ExecutionResult
Defined in: packages/gqless/src/Schema/types.ts:25
RetryOptions#
Ƭ RetryOptions: { maxRetries?: number ; retryDelay?: number | (attemptIndex: number) => number } | boolean | number
Defined in: packages/gqless/src/Error/retry.ts:6
ScalarsEnumsHash#
Ƭ ScalarsEnumsHash: Record<string, true>
Defined in: packages/gqless/src/Schema/types.ts:23
SelectionConstructorArgs#
Ƭ SelectionConstructorArgs: object
Type declaration:#
| Name | Type |
|---|---|
alias? | string |
argTypes? | Record<string, string> |
args? | Record<string, unknown> |
id | number |
key | string | number |
prevSelection? | Selection |
type? | SelectionType |
unions? | string[] |
Defined in: packages/gqless/src/Selection/selection.ts:7
Variables#
SchemaUnionsKey#
• Const SchemaUnionsKey: typeof SchemaUnionsKey
Defined in: packages/gqless/src/Schema/types.ts:8
Functions#
castNotSkeleton#
â–¸ ConstcastNotSkeleton<T>(v: T): NotSkeleton<T>
Runtime no-op that removes all the undefined types in the first level
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
v | T |
Returns: NotSkeleton<T>
Defined in: packages/gqless/src/Helpers/casters.ts:39
castNotSkeletonDeep#
â–¸ ConstcastNotSkeletonDeep<T>(v: T): NotSkeletonDeep<T>
Runtime no-op that removes all the undefined types recursively
Type parameters:#
| Name |
|---|
T |
Parameters:#
| Name | Type |
|---|---|
v | T |
Returns: NotSkeletonDeep<T>
Defined in: packages/gqless/src/Helpers/casters.ts:34
createClient#
â–¸ createClient<GeneratedSchema, ObjectTypesNames, ObjectTypes>(__namedParameters: ClientOptions<ObjectTypesNames, ObjectTypes>): GqlessClient<GeneratedSchema>
Type parameters:#
| Name | Type | Default |
|---|---|---|
GeneratedSchema | object | never |
GeneratedSchema.mutation | object | - |
GeneratedSchema.query | object | - |
GeneratedSchema.subscription | object | - |
ObjectTypesNames | string | never |
ObjectTypes | { [P in string]: object} | never |
Parameters:#
| Name | Type |
|---|---|
__namedParameters | ClientOptions<ObjectTypesNames, ObjectTypes> |
Returns: GqlessClient<GeneratedSchema>
Defined in: packages/gqless/src/Client/client.ts:198
debounce#
â–¸ debounce<T>(fn: (...args: T) => void, delay: number): function
Type parameters:#
| Name | Type |
|---|---|
T | unknown[] |
Parameters:#
| Name | Type |
|---|---|
fn | (...args: T) => void |
delay | number |
Returns: (...args: T) => void
Defined in: packages/gqless/src/Utils/debounce.ts:1
doRetry#
â–¸ doRetry(options: RetryOptions, state: RetryConfigState): void
Parameters:#
| Name | Type |
|---|---|
options | RetryOptions |
state | RetryConfigState |
Returns: void
Defined in: packages/gqless/src/Error/retry.ts:54
getArrayFields#
â–¸ getArrayFields<TArrayValue, TArray, TArrayValueKeys>(accessorArray: TArray, ...keys: TArrayValueKeys[]): TArray
Type parameters:#
| Name | Type |
|---|---|
TArrayValue | undefined | null | object |
TArray | undefined | null | TArrayValue[] |
TArrayValueKeys | string | number | symbol |
Parameters:#
| Name | Type |
|---|---|
accessorArray | TArray |
...keys | TArrayValueKeys[] |
Returns: TArray
Defined in: packages/gqless/src/Helpers/getFields.ts:15
getFields#
â–¸ getFields<TAccesorData, TAccesorKeys>(accessor: TAccesorData, ...keys: TAccesorKeys[]): TAccesorData
Type parameters:#
| Name | Type |
|---|---|
TAccesorData | undefined | null | object |
TAccesorKeys | string | number | symbol |
Parameters:#
| Name | Type |
|---|---|
accessor | TAccesorData |
...keys | TAccesorKeys[] |
Returns: TAccesorData
Defined in: packages/gqless/src/Helpers/getFields.ts:3
parseSchemaType#
â–¸ parseSchemaType(type: string): ParseSchemaTypeInfo
Parameters:#
| Name | Type |
|---|---|
type | string |
Returns: ParseSchemaTypeInfo
Defined in: packages/gqless/src/Schema/types.ts:37
prepass#
â–¸ prepass<T>(v: T, ...keys: (string | (string | PrepassObjKey)[])[]): T
Type parameters:#
| Name | Type |
|---|---|
T | undefined | null | object |
Parameters:#
| Name | Type |
|---|---|
v | T |
...keys | (string | (string | PrepassObjKey)[])[] |
Returns: T
Defined in: packages/gqless/src/Helpers/prepass.ts:12
selectFields#
â–¸ selectFields<A>(accessor: A, fields?: ** | (string | number)[], recursionDepth?: number*): A
Type parameters:#
| Name | Type |
|---|---|
A | undefined | null | object |
Parameters:#
| Name | Type | Default value |
|---|---|---|
accessor | A | - |
fields | ** | (string | number*)[] | '*' |
recursionDepth | number | 1 |
Returns: A
Defined in: packages/gqless/src/Helpers/selectFields.ts:4