The @graphql-tools/optimize package is designed to optimize GraphQL schemas and queries. It provides functionalities to simplify and enhance the performance of GraphQL operations by removing unnecessary fields, types, and directives, and by optimizing query execution.

What are @graphql-tools/optimize's main functionalities?

Optimize GraphQL Schema

This feature allows you to optimize GraphQL documents based on a given schema. It removes unused fragments and fields that are not required for the queries to execute, which can lead to performance improvements in query execution.

import { optimizeDocuments } from '@graphql-tools/optimize';
import { parse, print } from 'graphql';

const schema = parse(`type Query { hello: String }`);
const documents = [parse(`query { hello }`)];

const optimizedDocuments = optimizeDocuments(schema, documents);
console.log(print(optimizedDocuments[0]));

Remove Unused Types

This feature optimizes the GraphQL schema by removing types that are not used in any of the operations. This can help in reducing the size of the schema and improving the load times and performance of GraphQL servers.

import { optimizeSchema } from '@graphql-tools/optimize';
import { makeExecutableSchema } from '@graphql-tools/schema';

const schema = makeExecutableSchema({ typeDefs: `type Query { hello: String } type Unused { id: ID }` });
const optimizedSchema = optimizeSchema(schema);
console.log(optimizedSchema.getTypeMap());

Other packages similar to @graphql-tools/optimize

Readme

Source

GraphQL Tools: `DocumentNode` Optimizer

This package is intended to allow developers to optimize DocumentNode objects created by graphql library.

It's built as a set of small optimizers you can compose to get the most out of your GraphQL setup.

The goal of this package is mostly around making optimizations for the way the data is stored in DocumentNode, and not to the essence of the DocumentNode.

Getting Started

yarn add -D @graphql-tools/optimize

API

To get started with this tool, import it and run it over your DocumentNode.

import { optimizeDocumentNode } from '@graphql-tools/optimize';

const myDocument: DocumentNode = { ... }
const optimizedDocument = optimizeDocumentNode(myDocument);

Customizing Optimizers

By default, we apply all optimizers available in this repo over your document. It shouldn't effect any runtime since we just remove dead or unused areas.

You can modify the list of optimizers this way:

import { optimizeDocumentNode, removeDescriptions } from '@graphql-tools/optimize';

const myDocument: DocumentNode = { ... }
const optimizedDocument = optimizeDocumentNode(myDocument, [removeDescriptions]);

Writing your own optimizer

You can create your own optimizer to manipulate DocumentNode, the API signature is pretty simple:

export type DocumentOptimizer = (input: DocumentNode) => DocumentNode

Take a look at [./optimizers](this directory for inspiration and implementation reference).

FAQs

What is @graphql-tools/optimize?

Is @graphql-tools/optimize popular?

Is @graphql-tools/optimize well maintained?

Last updated on 19 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install