graphql

func AddInitFunc ¶ added in v0.2.4

func AddInitFunc(rank int, initFunc transport.WebsocketInitFunc) module.Option

AddInitFunc registers a transport.WebsocketInitFunc that runs whenever a WebSocket subscription connection is initialized (i.e. on the client's "connection_init" message). InitFuncs are ranked the same way http.AddMiddlewareToPipeline ranks HTTP middlewares: lower ranks run first, same-rank entries run in registration order. Each one acts like a middleware, receiving the context and InitPayload produced by the previous one (see InitFunc), and can reject the connection by returning an error or thread values through the context for the next InitFunc and the resolvers.

If your InitFunc needs its own dependencies (e.g. an authenticator resolved through DI), use AddInitFuncFactory instead.

func AddInitFuncFactory ¶ added in v0.2.4

func AddInitFuncFactory[T InitFuncFactory](rank int) module.Option

AddInitFuncFactory registers an InitFuncFactory whose own dependencies are resolved through DI: T is constructed by the container (so its constructor can request whatever it needs, e.g. an authenticator or a repository), and the transport.WebsocketInitFunc it returns from InitFunc() is added to the registry at rank, same as AddInitFunc. This mirrors how http.AddMiddlewareFactoryToPipeline builds an HTTP middleware with dependencies via http.MiddlewareFactory.

The concrete type T must be registered as a provider elsewhere (typically in the consuming module's own AddProviders call), the same way a MiddlewareFactory implementation is.

func DecorateServer ¶ added in v0.2.3

func DecorateServer(decorator any) module.Option

DecorateServer - decorates GraphQL server with additional options. decorator is a function that gets server with additional dependencies and returns a server Example: DecorateServer(func(srv *handler.Server) *handler.Server)

func DecorateWithDependency ¶ added in v0.2.3

func DecorateWithDependency[T any](decorator func(srv *handler.Server, dep T) *handler.Server) module.Option

func GetLoader ¶

func GetLoader[K comparable, T any](ctx context.Context, factory LoaderFactory[K, T]) *dataloader.Loader[K, T]

func InitFunc ¶ added in v0.2.4

func InitFunc(registry *InitFuncRegistry) transport.WebsocketInitFunc

InitFunc composes all registered transport.WebsocketInitFunc (see AddInitFunc/AddInitFuncFactory) into a single one, used as the Websocket transport's InitFunc. Registered functions run in rank order, acting like a middleware chain: each one receives the context and InitPayload produced by the previous one, and can reject the connection by returning an error, or thread values through the context for the next InitFunc and for the resolvers. The registry is read on every call rather than once here, since fx.Invoke registrations that populate it (see AddInitFunc) must all have already run by the time a real connection triggers this - reading it once at provide-time could race a registration that hasn't happened yet.

func NewErrorPresenter ¶

func NewErrorPresenter(params ErrorPresenterParams) graphql.ErrorPresenterFunc

func NewGraphiQLHandler ¶ added in v0.2.4

func NewGraphiQLHandler(title, endpoint string, subscriptionsEnabled bool) http.HandlerFunc

NewGraphiQLHandler renders GraphiQL 5 (the current major version - it dropped the UMD CDN bundle gqlgen's own playground.Handler relies on, so this ships its own ESM-based page instead of using that helper).

subscriptionsEnabled should be true only when the server's subscription transport is graphql-ws-compatible (i.e. config.SubscriptionTransport == "ws"); GraphiQL's fetcher wires subscriptions over graphql-ws, which doesn't speak the SSE-based subscription protocol.

func NewGraphqlServer ¶

func NewGraphqlServer(
	params ServerParams,
) *handler.Server

func NewHandlerRoute ¶

func NewHandlerRoute(handler *handler.Server, config Config) (modulusHttp.RouteProvider, modulusHttp.RouteProvider)

func NewManifesto ¶

func NewManifesto() module.Manifesto

NewManifestModule creates a new graphql module with the manifest module.

func NewModule ¶

func NewModule(options ...module.Option) *module.Module

func NewPlaygroundHandlerRoute ¶

func NewPlaygroundHandlerRoute(config Config) modulusHttp.RouteProvider

func OverrideErrorPresenter ¶

func OverrideErrorPresenter[T ErrorPresenterFactory](gqlModule *module.Module) *module.Module

OverrideErrorPresenter overrides the error presenter provider.

func WithLoaders ¶

func WithLoaders(ctx context.Context, loaders *sync.Map) context.Context