Skip to main content

Table of contents

Enumerations#

Classes#

Interfaces#

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

Type declaration:#

NameType
mutation?Record<string, unknown>
query?Record<string, unknown>
subscription?Record<string, unknown>

Defined in: packages/gqless/src/Cache/dataCache.ts:6


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


QueryFetcher#

Ƭ QueryFetcher: (query: string, variables?: Record<string, any>) => Promise<ExecutionResult> | ExecutionResult

Type declaration:#

▸ (query: string, variables?: Record<string, any>): Promise<ExecutionResult> | ExecutionResult

Parameters:#

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

NameType
alias?string
argTypes?Record<string, string>
args?Record<string, unknown>
idnumber
keystring | 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:#

NameType
vT

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

NameType
vT

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

NameTypeDefault
GeneratedSchemaobjectnever
GeneratedSchema.mutationobject-
GeneratedSchema.queryobject-
GeneratedSchema.subscriptionobject-
ObjectTypesNamesstringnever
ObjectTypes{ [P in string]: object}never

Parameters:#

NameType
__namedParametersClientOptions<ObjectTypesNames, ObjectTypes>

Returns: GQlessClient<GeneratedSchema>

Defined in: packages/gqless/src/Client/client.ts:201


debounce#

debounce<T>(fn: (...args: T) => void, delay: number): function

Type parameters:#

NameType
Tunknown[]

Parameters:#

NameType
fn(...args: T) => void
delaynumber

Returns: (...args: T) => void

Defined in: packages/gqless/src/Utils/debounce.ts:1


doRetry#

doRetry(options: RetryOptions, state: RetryConfigState): void

Parameters:#

NameType
optionsRetryOptions
stateRetryConfigState

Returns: void

Defined in: packages/gqless/src/Error/retry.ts:54


getArrayFields#

getArrayFields<TArrayValue, TArray, TArrayValueKeys>(accessorArray: TArray, ...keys: TArrayValueKeys[]): TArray

Type parameters:#

NameType
TArrayValueundefined | null | object
TArrayundefined | null | TArrayValue[]
TArrayValueKeysstring | number | symbol

Parameters:#

NameType
accessorArrayTArray
...keysTArrayValueKeys[]

Returns: TArray

Defined in: packages/gqless/src/Helpers/getFields.ts:15


getFields#

getFields<TAccesorData, TAccesorKeys>(accessor: TAccesorData, ...keys: TAccesorKeys[]): TAccesorData

Type parameters:#

NameType
TAccesorDataundefined | null | object
TAccesorKeysstring | number | symbol

Parameters:#

NameType
accessorTAccesorData
...keysTAccesorKeys[]

Returns: TAccesorData

Defined in: packages/gqless/src/Helpers/getFields.ts:3


parseSchemaType#

parseSchemaType(type: string): ParseSchemaTypeInfo

Parameters:#

NameType
typestring

Returns: ParseSchemaTypeInfo

Defined in: packages/gqless/src/Schema/types.ts:37


prepass#

prepass<T>(v: T, ...keys: (string | (string | PrepassObjKey)[])[]): T

Type parameters:#

NameType
Tundefined | null | object

Parameters:#

NameType
vT
...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:#

NameType
Aundefined | null | object

Parameters:#

NameTypeDefault value
accessorA-
fields"*" | (string | number)[]'*'
recursionDepthnumber1

Returns: A

Defined in: packages/gqless/src/Helpers/selectFields.ts:3

Last updated on by github-actions[bot]