@graphql-tools/load

What is @graphql-tools/load?

@graphql-tools/load is a part of the GraphQL Tools ecosystem that allows you to load GraphQL schema and documents from various sources. It supports loading from files, URLs, and even code strings, making it versatile for different use cases in GraphQL development.

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

Load schema from a file

This feature allows you to load a GraphQL schema from a file. The code sample demonstrates how to use the `loadSchema` function along with the `GraphQLFileLoader` to load a schema from a specified file path.

const { loadSchema } = require('@graphql-tools/load');
const { GraphQLFileLoader } = require('@graphql-tools/graphql-file-loader');

async function loadSchemaFromFile() {
  const schema = await loadSchema('path/to/schema.graphql', {
    loaders: [new GraphQLFileLoader()]
  });
  console.log(schema);
}

loadSchemaFromFile();

Load schema from a URL

This feature allows you to load a GraphQL schema from a URL. The code sample demonstrates how to use the `loadSchema` function along with the `UrlLoader` to load a schema from a specified URL.

const { loadSchema } = require('@graphql-tools/load');
const { UrlLoader } = require('@graphql-tools/url-loader');

async function loadSchemaFromURL() {
  const schema = await loadSchema('https://example.com/graphql', {
    loaders: [new UrlLoader()]
  });
  console.log(schema);
}

loadSchemaFromURL();

Load schema from a code string

This feature allows you to load a GraphQL schema from a code string. The code sample demonstrates how to use the `loadSchema` function to load a schema directly from a string containing the schema definition.

const { loadSchema } = require('@graphql-tools/load');
const { GraphQLFileLoader } = require('@graphql-tools/graphql-file-loader');

const schemaString = `
  type Query {
    hello: String
  }
`;

async function loadSchemaFromString() {
  const schema = await loadSchema(schemaString, {
    loaders: [new GraphQLFileLoader()]
  });
  console.log(schema);
}

loadSchemaFromString();

Other packages similar to @graphql-tools/load

graphql-import

graphql-import allows you to import .graphql files into your JavaScript or TypeScript code. It is similar to @graphql-tools/load in that it helps in loading GraphQL schemas, but it is more focused on importing and merging schema files.

apollo-server

apollo-server is a fully-featured GraphQL server that also includes utilities for loading schemas from various sources. While it provides more than just schema loading, its schema loading capabilities are comparable to those of @graphql-tools/load.

graphql-tools

graphql-tools is a comprehensive set of utilities for building and maintaining GraphQL schemas. It includes schema loading capabilities similar to @graphql-tools/load, but also offers additional features like schema stitching and mocking.

README

Check API Reference for more information about this package; https://www.graphql-tools.com/docs/api/modules/load_src

You can also learn more about Apollo Links in Schema Loading in this chapter; https://www.graphql-tools.com/docs/schema-loading

You can also learn more about Apollo Links in Documents Loading in this chapter; https://www.graphql-tools.com/docs/documents-loading