Envelop

⚠️

If you are using GraphQL Yoga, please use the dedicated GraphQL Yoga plugin for Hive.

Installation

npm i @graphql-hive/envelop

We recommend installing Hive Client package as a direct dependency of your project, because it includes a runtime to send usage reports and schemas to Hive registry.

The @graphql-hive/envelop package exports an Envelop plugin, that can be used directly with any server that supports Envelop.

Configuration

A full configuration guide can be found in the “Configuration” page.

Integration Guide

Publishing Schemas

Please use the Hive CLI to publish your GraphQL schema. Follow the CI/CD instructions for automating the process.

Usage Reporting

💡

For more configuration options, such as sampling, client name and version reporting, please refer to the Hive client configuration reference.

You can send usage reporting to Hive registry by using the usage section of the configuration:

import { createServer } from 'node:http'
import { createYoga } from 'graphql-yoga'
import { useHive } from '@graphql-hive/envelop'
import { schema } from './schema'
 
const plugin = useHive({
  enabled: true, // Enable/Disable Hive Client
  token: 'YOUR-TOKEN',
  usage: true
})

Additional Resources

GraphQL Mesh Schema Stitching