maxDepthPlugin

Package nameWeekly DownloadsVersionLicenseUpdated
@escape.tech/graphql-armor-max-depthDownloadsVersionLicenseNov 22nd, 2022

Installation

yarn add @escape.tech/graphql-armor-max-depth

@escape.tech/graphql-armor-max-depth

This plugin will limit the depth in a GraphQL query.

Getting Started

# npm
npm install @escape.tech/graphql-armor-max-depth
 
# yarn
yarn add @escape.tech/graphql-armor-max-depth

Usage example

With @graphql/graphql-js

import { maxDepthRule } from '@escape.tech/graphql-armor-max-depth';

With @envelop/core from @the-guild-org

import { envelop } from '@envelop/core';
import { maxDepthPlugin } from '@escape.tech/graphql-armor-max-depth';
 
const getEnveloped = envelop({
  plugins: [
    // ... other plugins ...
    maxDepthPlugin({
        n: 6, // Number of depth allowed | Default: 6
    }),
  ]
})