graphqexl v0.1.0-alpha-rc.24 API Reference

Modules

Fully-loaded GraphQL implementation with server and developer tools.

GraphQL query, comprised of one or more Graphqexl.Query.Operation.t/0s.

Individual operation contained in a query

Result of a GraphQL Graphqexl.Query.t/0 operation, including any errors

Structured representation of a GraphQL schema, either built dynamically or parsed from a JSON document or GQL string.

GraphQL argument, belonging to e.g. a Query or Mutation

Domain-Specific Language for expressing and parsing a GQL string as a Graphqexl.Schema.t/0

Establishes a GenServer to cache the loadedGraphQL schema.

GraphQL Interface, encapsulating a group of Graphqexl.Schema.Field.t/0 to be shared between Graphqexl.Schema.Type.t/0

GraphQL mutation

GraphQL query

Ref struct, representing a connection to another user-defined type (that may not yet actually be defined in the run-time context)

Wrapper struct indicating the wrapped type is required on its parent

GraphQL subscription

GraphQL enum type.

GraphQL custom type

GraphQL union type

Server Plug to handle parsing and executing GraphQL queries, which can be given as application/json or application/graphql

Plug that makes an Graphqexl.Schema.executable/1 available to further plugs/handlers, using the Graphqexl.Schema.Executable GenServer.

Plug.Router-based server Plug to serve as the main entrypoint for the development server. It serves both the Graphql Playground developer UI as well as the GraphQL API.

Mostly a databag module containing keywords, tokens and regex patterns related to the GraphQL spec. Also contains functions for fetching them by key.

Utility module with helper functions for working with Regex.t/0's.

Contains some basic fake post, comment and user data to use in development/testing.

Basic tree traversal algorithms, implementing depth-first and breadth-first traversal.

Primarily a struct for representing tree data to be processed with the Tree.Traverse module. Also includes implementations necessary for the Enumerable protocol and conversion functions to/from ordinary Map.t/0 representations of the same data.

Mix Tasks

Build the application's Docker Image

Publish the built application container to the given image repo

Starts the application by configuring all endpoints servers to run.

Perform linting and static analysis using Lefthook as a runner for tools like Credo