@graphql-tools/graphql-tag-pluck

What is @graphql-tools/graphql-tag-pluck?

The @graphql-tools/graphql-tag-pluck package is designed to extract GraphQL query strings from JavaScript and TypeScript files. It can pluck GraphQL queries from template literals in your code, which is useful when you want to separate GraphQL operations from the rest of your JavaScript codebase for preprocessing or compilation purposes.

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

Plucking GraphQL queries from JavaScript/TypeScript files

This feature allows you to extract GraphQL queries from a specified JavaScript or TypeScript file. The `gqlPluckFromFile` function reads the file and returns a promise that resolves with the extracted queries.

const { gqlPluckFromFile } = require('@graphql-tools/graphql-tag-pluck');

async function getQueries() {
  const filePath = 'path/to/your/file.js';
  const gqlQueries = await gqlPluckFromFile(filePath);
  console.log(gqlQueries);
}

getQueries();

Plucking GraphQL queries from a string

This feature allows you to extract GraphQL queries from a string containing code. The `gqlPluckFromCodeString` function takes a string as input and returns a promise that resolves with the extracted queries.

const { gqlPluckFromCodeString } = require('@graphql-tools/graphql-tag-pluck');

async function getQueriesFromString(codeString) {
  const gqlQueries = await gqlPluckFromCodeString(codeString);
  console.log(gqlQueries);
}

const code = "const query = gql`{ user { id } }`";
getQueriesFromString(code);

Other packages similar to @graphql-tools/graphql-tag-pluck

graphql-tag

The graphql-tag package is commonly used to parse GraphQL query strings into a standard GraphQL AST. It is similar to @graphql-tools/graphql-tag-pluck in that it deals with GraphQL queries in JavaScript files, but it does not provide the functionality to extract queries from arbitrary code locations.

babel-plugin-graphql-tag

This package provides a Babel plugin that compiles GraphQL queries using the graphql-tag library at build time. It is similar to @graphql-tools/graphql-tag-pluck in that it processes GraphQL queries in JavaScript files, but it operates as part of the Babel compilation process rather than as a standalone tool for extracting queries.

README

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

You can also learn more about GraphQL Tag Pluck in this chapter; https://www.graphql-tools.com/docs/graphql-tag-pluck