Documentation ¶
Index ¶
- func GenerateCode(data *Data) error
- type ArgSet
- type AugmentedSource
- type Data
- type Directive
- func (d *Directive) ArgsFunc() string
- func (d *Directive) CallArgs() string
- func (d *Directive) CallName() string
- func (d *Directive) CallPath() string
- func (d *Directive) Declaration() string
- func (d *Directive) FunctionImpl() string
- func (d *Directive) IsBuiltIn() bool
- func (d *Directive) IsLocation(location ...ast.DirectiveLocation) bool
- func (d *Directive) ResolveArgs(obj string, next int) string
- type DirectiveList
- type Field
- func (f *Field) ArgsFunc() string
- func (f *Field) CallArgs() string
- func (f *Field) ChildFieldContextFunc(name string) string
- func (f *Field) ComplexityArgs() string
- func (f *Field) ComplexitySignature() string
- func (f *Field) DirectiveObjName() string
- func (f *Field) FieldContextFunc() string
- func (f *Field) GoNameUnexported() string
- func (f *Field) GoResultName() (string, bool)
- func (f *Field) HasDirectives() bool
- func (f *Field) ImplDirectives() []*Directive
- func (f *Field) IsConcurrent() bool
- func (f *Field) IsInputObject() bool
- func (f *Field) IsMap() bool
- func (f *Field) IsMethod() bool
- func (f *Field) IsReserved() bool
- func (f *Field) IsRoot() bool
- func (f *Field) IsVariable() bool
- func (f *Field) ResolverType() string
- func (f *Field) ShortInvocation() string
- func (f *Field) ShortResolverDeclaration() string
- func (f *Field) ShortResolverSignature(ft *goast.FuncType) string
- type FieldArgument
- type GoFieldType
- type Interface
- type InterfaceImplementor
- type Object
- func (o *Object) Description() string
- func (o *Object) HasDirectives() bool
- func (o *Object) HasField(name string) bool
- func (o *Object) HasResolvers() bool
- func (o *Object) HasUnmarshal() bool
- func (o *Object) Implementors() string
- func (o *Object) IsConcurrent() bool
- func (o *Object) IsMap() bool
- func (o *Object) IsReserved() bool
- func (o *Object) Reference() types.Type
- func (o *Object) UniqueFields() map[string][]*Field
- type Objects
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateCode ¶ added in v0.17.57
Types ¶
type ArgSet ¶ added in v0.17.57
type ArgSet struct { Args []*FieldArgument FuncDecl string }
type AugmentedSource ¶ added in v0.17.57
type AugmentedSource struct { // path relative to Config.Exec.Filename RelativePath string Embeddable bool BuiltIn bool Source string }
AugmentedSource contains extra information about graphql schema files which is not known directly from the Config.Sources data
type Data ¶ added in v0.17.57
type Data struct { Config *config.Config Schema *ast.Schema // If a schema is broken up into multiple Data instance, each representing part of the schema, // AllDirectives should contain the directives for the entire schema. Directives() can // then be used to get the directives that were defined in this Data instance's sources. // If a single Data instance is used for the entire schema, AllDirectives and Directives() // will be identical. // AllDirectives should rarely be used directly. AllDirectives DirectiveList Objects Objects Inputs Objects Interfaces map[string]*Interface ReferencedTypes map[string]*config.TypeReference ComplexityRoots map[string]*Object QueryRoot *Object MutationRoot *Object SubscriptionRoot *Object AugmentedSources []AugmentedSource Plugins []any }
Data is a unified model of the code to be generated. Plugins may modify this structure to do things like implement resolvers or directives automatically (eg grpc, validation)
func (*Data) Args ¶ added in v0.17.57
func (d *Data) Args() map[string][]*FieldArgument
func (*Data) BuiltInDirectives ¶ added in v0.17.57
func (d *Data) BuiltInDirectives() DirectiveList
Get only the directives which should have a statically provided definition
func (*Data) Directives ¶ added in v0.17.57
func (d *Data) Directives() DirectiveList
Get only the directives which are defined in the config's sources.
func (*Data) HasEmbeddableSources ¶ added in v0.17.57
func (*Data) UserDirectives ¶ added in v0.17.57
func (d *Data) UserDirectives() DirectiveList
Get only the directives which should have a user provided definition on server instantiation
type Directive ¶
type Directive struct { *ast.DirectiveDefinition Name string Args []*FieldArgument config.DirectiveConfig }
func (*Directive) Declaration ¶
func (*Directive) FunctionImpl ¶ added in v0.17.57
func (*Directive) IsLocation ¶ added in v0.17.57
func (d *Directive) IsLocation(location ...ast.DirectiveLocation) bool
IsLocation check location directive
type DirectiveList ¶ added in v0.17.57
func (DirectiveList) LocationDirectives ¶ added in v0.17.57
func (dl DirectiveList) LocationDirectives(location string) DirectiveList
LocationDirectives filter directives by location
type Field ¶
type Field struct { *ast.FieldDefinition TypeReference *config.TypeReference GoFieldType GoFieldType // The field type in go, if any GoReceiverName string // The name of method & var receiver in go, if any GoFieldName string // The name of the method or var in go, if any IsResolver bool // Does this field need a resolver Args []*FieldArgument // A list of arguments to be passed to this field MethodHasContext bool // If this is bound to a go method, does the method also take a context NoErr bool // If this is bound to a go method, does that method have an error as the second argument VOkFunc bool // If this is bound to a go method, is it of shape (interface{}, bool) Object *Object // A link back to the parent object Default any // The default value Stream bool // does this field return a channel? Directives []*Directive }
func (*Field) ChildFieldContextFunc ¶ added in v0.17.57
func (*Field) ComplexityArgs ¶ added in v0.5.0
func (*Field) ComplexitySignature ¶ added in v0.5.0
func (*Field) DirectiveObjName ¶ added in v0.17.57
func (*Field) FieldContextFunc ¶ added in v0.17.57
func (*Field) GoNameUnexported ¶
func (*Field) GoResultName ¶ added in v0.17.57
func (*Field) HasDirectives ¶ added in v0.17.57
func (*Field) ImplDirectives ¶ added in v0.17.57
func (*Field) IsConcurrent ¶
func (*Field) IsInputObject ¶ added in v0.17.57
func (*Field) IsReserved ¶ added in v0.5.0
func (*Field) IsVariable ¶
func (*Field) ResolverType ¶
func (*Field) ShortInvocation ¶
func (*Field) ShortResolverDeclaration ¶
type FieldArgument ¶
type FieldArgument struct { *ast.ArgumentDefinition TypeReference *config.TypeReference VarName string // The name of the var in go Object *Object // A link back to the parent object Default any // The default value Directives []*Directive Value any // value set in Data CallArgumentDirectivesWithNull bool }
func (*FieldArgument) DirectiveObjName ¶ added in v0.17.57
func (f *FieldArgument) DirectiveObjName() string
func (*FieldArgument) ImplDirectives ¶ added in v0.17.57
func (f *FieldArgument) ImplDirectives() []*Directive
ImplDirectives get not SkipRuntime and location ARGUMENT_DEFINITION directive
func (*FieldArgument) Stream ¶
func (f *FieldArgument) Stream() bool
type GoFieldType ¶
type GoFieldType int
const ( GoFieldUndefined GoFieldType = iota GoFieldMethod GoFieldVariable GoFieldMap )
type Interface ¶
type Interface struct { *ast.Definition Type types.Type Implementors []InterfaceImplementor InTypemap bool }
type InterfaceImplementor ¶
type InterfaceImplementor struct { *ast.Definition Type types.Type TakeRef bool }
func (*InterfaceImplementor) CanBeNil ¶ added in v0.17.57
func (i *InterfaceImplementor) CanBeNil() bool
type Object ¶
type Object struct { *ast.Definition Type types.Type ResolverInterface types.Type Root bool Fields []*Field Implements []*ast.Definition DisableConcurrency bool Stream bool Directives []*Directive PointersInUnmarshalInput bool }