jakobo/envelop-plugin-extensions

Set extensions via your GraphQL Context

envelop-plugin-extensions
_{🔌 Set extensions via your GraphQL Context}

A plugin for the envelop ecosystem that adds the ability to read, set, and clear GraphQL extensions. Works with any plugin in the Envelop ecosystem, including GraphQL Yoga v3.

Getting Started

# or yarn, or npm
pnpm add envelop-plugin-extensions

Usage

Configure useExtensions() like you would any other envelop plugin. For example, in GraphQL Yoga:

import {
  useExtensions,
  type ExtensionsContext,
} from "envelop-plugin-extensions";
import { createYoga, createSchema } from "graphql-yoga";

// Provide your schema
const yoga = createYoga({
  schema: createSchema({
    typeDefs: /* GraphQL */ `
      type Query {
        greetings: String!
      }
    `,
    resolvers: {
      Query: {
        greetings: (parent, args, context, info) => {
          // set an extension value. context.extensions is Map<string, unknown>
          context.extensions.set("extension key", "extension value");
          return "Hello World!";
        },
      },
    },
  }),
  plugins: [useExtensions(options)],
});

// Start the server and explore http://localhost:4000/graphql
const server = createServer(yoga);
server.listen(4000, () => {
  console.info("Server is running on http://localhost:4000/graphql");
});

And see the extensions property carried into the response:

{
  "data": {
    "greetings": "Hello World!"
  },
  "extensions": {
    "extension key": "extension value"
  }
}

Options

• filter: (key: string, value: unknown) => boolean - Allows filtering extensions by top-level key. Not all extensions should be surfaced, and filter() gives you a means to run a test against every key/value before the extensions are written to the graphql response. TypeScript Users: the type for value is unknown, and it's expected if you're checking extension values you have suitable typeguards or validators.

License

MIT