Skip to content

garph

garph

Classes

Type Aliases

AnyArgs

Ƭ AnyArgs: Type<any, "Args">

Defined in

index.ts:58


AnyBoolean

Ƭ AnyBoolean: Type<boolean, "Boolean">

Defined in

index.ts:46


AnyEnum

Ƭ AnyEnum: Type<any, "Enum">

Defined in

index.ts:54


AnyFloat

Ƭ AnyFloat: Type<number, "Float">

Defined in

index.ts:49


AnyID

Ƭ AnyID: Type<string, "ID">

Defined in

index.ts:45


AnyInput

Ƭ AnyInput: Type<any, "InputType">

Defined in

index.ts:56


AnyInt

Ƭ AnyInt: Type<number, "Int">

Defined in

index.ts:48


AnyInterface

Ƭ AnyInterface: Type<any, "InterfaceType">

Defined in

index.ts:57


AnyList

Ƭ AnyList: Type<any, "List">

Defined in

index.ts:51


AnyNumber

Ƭ AnyNumber: Type<number, any>

Defined in

index.ts:47


AnyObject

Ƭ AnyObject: Type<any, "ObjectType">

Defined in

index.ts:60


AnyObjects

Ƭ AnyObjects: Object

Index signature

▪ [key: string]: AnyObject

Defined in

index.ts:71


AnyOmitResolver

Ƭ AnyOmitResolver: Type<any, "OmitResolver">

Defined in

index.ts:61


AnyOptional

Ƭ AnyOptional: Type<any, "Optional">

Defined in

index.ts:59


AnyPaginatedList

Ƭ AnyPaginatedList: Type<any, "PaginatedList">

Defined in

index.ts:52


AnyRef

Ƭ AnyRef: Type<any, "Ref">

Defined in

index.ts:50


AnyScalar

Ƭ AnyScalar: Type<any, "Scalar">

Defined in

index.ts:55


AnyString

Ƭ AnyString: Type<string, "String">

Defined in

index.ts:44


AnyType

Ƭ AnyType: Type<any, any>

Defined in

index.ts:43


AnyTypes

Ƭ AnyTypes: Object

Index signature

▪ [key: string]: AnyType

Defined in

index.ts:67


AnyUnion

Ƭ AnyUnion: Type<any, "Union">

Defined in

index.ts:53


Args

Ƭ Args: Object

Index signature

▪ [key: string]: AnyType

Defined in

index.ts:63


Infer

Ƭ Infer<T, options>: ExpandRecursively<InferRaw<T, options>>

Type parameters

NameType
TT
optionsextends InferOptions = { omitResolver: never }

Defined in

index.ts:93


InferArg

Ƭ InferArg<T>: ExpandRecursively<InferArgRaw<T>>

Type parameters

Name
T

Defined in

index.ts:125


InferArgRaw

Ƭ InferArgRaw<T>: T extends AnyArgs ? { [K in keyof T["_args"] as T["_args"][K] extends AnyOptional ? never : K]: InferRaw<T["_args"][K]> } & { [K in keyof T["_args"] as T["_args"][K] extends AnyOptional ? K : never]?: InferRaw<T["_args"][K]> } : never

Type parameters

Name
T

Defined in

index.ts:126


InferArgs

Ƭ InferArgs<T>: ExpandRecursively<InferArgsRaw<T>>

Type parameters

NameType
Textends AnyType

Defined in

index.ts:120


InferArgsRaw

Ƭ InferArgsRaw<T>: T extends AnyObject | AnyInterface ? { [K in keyof T["_shape"]]: InferArgRaw<T["_shape"][K]> } : never

Type parameters

NameType
Textends AnyType

Defined in

index.ts:121


InferRaw

Ƭ InferRaw<T, options>: T extends AnyInput | AnyObject | AnyInterface ? { __typename?: T["_name"] } & { [K in keyof T["_shape"] as T["_shape"][K] extends AnyOptional | options["omitResolver"] ? never : T["_shape"][K] extends AnyArgs ? T["_shape"][K]["_shape"] extends AnyOptional | options["omitResolver"] ? never : K : K]: InferRaw<T["_shape"][K], options> } & { [K in keyof T["_shape"] as T["_shape"][K] extends AnyOptional | options["omitResolver"] ? K : T["_shape"][K] extends AnyArgs ? T["_shape"][K]["_shape"] extends AnyOptional | options["omitResolver"] ? K : never : never]?: InferRaw<T["_shape"][K], options> } : InferShallow<T, options>

Type parameters

NameType
TT
optionsextends InferOptions = { omitResolver: never }

Defined in

index.ts:94


InferResolvers

Ƭ InferResolvers<T, X>: { [K in keyof T]: K extends "Subscription" ? { [G in keyof T[K]["_shape"]]?: Object } : { [G in keyof T[K]["_shape"]]?: Function } | { [G in keyof T[K]["_shape"]]?: Object | Object | Object } & Object }

Type parameters

NameType
Textends AnyTypes
Xextends InferResolverConfig

Defined in

index.ts:134


InferResolversStrict

Ƭ InferResolversStrict<T, X>: { [K in keyof T]: K extends "Subscription" ? { [G in keyof T[K]["_shape"]]: Object } : { [G in keyof T[K]["_shape"]]: Function } | { [G in keyof T[K]["_shape"]]: Object | Object | Object } & Object }

Type parameters

NameType
Textends AnyTypes
Xextends InferResolverConfig

Defined in

index.ts:156


InferShallow

Ƭ InferShallow<T, options>: T extends AnyString | AnyID | AnyScalar | AnyNumber | AnyBoolean ? T["_shape"] : T extends AnyEnum ? T["_inner"] : T extends AnyUnion ? InferRaw<ObjectToUnion<T["_inner"]>, options> : T extends AnyList ? InferRaw<T["_shape"], options>[] : T extends AnyPaginatedList ? T["_inner"] : T extends AnyOptional ? InferRaw<T["_shape"], options> | null | undefined : T extends AnyOmitResolver ? InferRaw<T["_shape"], options> : T extends AnyArgs ? InferRaw<T["_shape"], options> : T extends AnyRef ? InferRaw<T["_inner"], options> : T

Type parameters

NameType
TT
optionsextends InferOptions = { omitResolver: never }

Defined in

index.ts:108


InferUnionNames

Ƭ InferUnionNames<T>: T extends AnyUnion ? ObjectToUnion<T["_inner"]>["_name"] : never

Type parameters

Name
T

Defined in

index.ts:132


TypeDefinition

Ƭ TypeDefinition<T>: Object

Type parameters

Name
T

Type declaration

NameType
args?Args
defaultValue?any
deprecated?string
description?string
extend?AnyTypes[]
interfaces?AnyInterface[]
isOptional?boolean
isRequired?boolean
name?string
scalarOptions?ScalarOptions<any, any>
shape?T
typeGarphType

Defined in

index.ts:28

Variables

g

Const g: GarphSchema

Defined in

index.ts:729

Functions

buildSchema

buildSchema(«destructured», config?): GraphQLSchema

Parameters

NameType
«destructured»Object
› gGarphSchema
› resolvers?any
configConverterConfig

Returns

GraphQLSchema

Defined in

schema.ts:17


printSchema

printSchema(g, config?): string

Parameters

NameType
gGarphSchema
configConverterConfig

Returns

string

Defined in

schema.ts:11