directives

Documentation

Overview

package directives contains a Visitor Pattern implementation of Schema Directives for Fields.

Index

• type Directive
• type Resolver
• type ResolverInterceptor
• type Validator

Types

type Directive

type Directive interface {
	ImplementsDirective() string
}

Directive defines the interface that clients should use to implement a custom Directive. Implementations then choose to implement other *optional* interfaces based on the needs of the directive, but each must implement *at least 1* of the optional functions

See the graphql.Directives() Schema Option.

type Resolver

type Resolver interface {
	Resolve(ctx context.Context, args interface{}) (output interface{}, err error)
}

Resolver for a field definition during execution of a request.

type ResolverInterceptor

type ResolverInterceptor interface {
	Resolve(ctx context.Context, args interface{}, next Resolver) (output interface{}, err error)
}

ResolverInterceptor for a field resolver function, applying the directive logic. This is an *optional* directive function (at least 1 optional function must be declared for each directive).

type Validator

type Validator interface {
	Validate(ctx context.Context, args interface{}) error
}

Validator directive which executes before anything is resolved, allowing the request to be rejected.