@envelop/core

Plugin System

The plugin system allows you to add various plugins to your GraphQL server. In this example, we use the `useSchema` plugin to set up a basic schema.

const { envelop, useSchema } = require('@envelop/core');
const { makeExecutableSchema } = require('@graphql-tools/schema');

const schema = makeExecutableSchema({
  typeDefs: `
    type Query {
      hello: String
    }
  `,
  resolvers: {
    Query: {
      hello: () => 'Hello world!',
    },
  },
});

const getEnveloped = envelop({
  plugins: [useSchema(schema)],
});

const { parse, validate, contextFactory, execute, schema: finalSchema } = getEnveloped();

Custom Plugins

You can create custom plugins to extend the functionality of your GraphQL server. This example shows a custom plugin that logs the operation name whenever an operation is executed.

const { envelop, useLogger } = require('@envelop/core');

const customPlugin = {
  onExecute({ args }) {
    console.log('Executing operation:', args.operationName);
  },
};

const getEnveloped = envelop({
  plugins: [useLogger(), customPlugin],
});

const { execute } = getEnveloped();

Error Handling

The error handling feature allows you to manage and log errors that occur during GraphQL operations. This example demonstrates how to use the `useErrorHandler` plugin to log errors.

const { envelop, useErrorHandler } = require('@envelop/core');

const errorHandlerPlugin = useErrorHandler((errors) => {
  console.error('GraphQL Errors:', errors);
});

const getEnveloped = envelop({
  plugins: [errorHandlerPlugin],
});

const { execute } = getEnveloped();