graphql_tag_pluck_src.graphqltagpluckoptions

Interface: GraphQLTagPluckOptions#

graphql-tag-pluck/src.GraphQLTagPluckOptions

Additional options for determining how a file is parsed.

Hierarchy#

  • GraphQLTagPluckOptions

Table of contents#

Properties#

Properties#

globalGqlIdentifierName#

Optional globalGqlIdentifierName: string | string[]

Allows to use a global identifier instead of a module import.

// `graphql` is a global function
export const usersQuery = graphql`
{
users {
id
name
}
}
`;

Defined in: packages/graphql-tag-pluck/src/index.ts:100


gqlMagicComment#

Optional gqlMagicComment: string

The magic comment anchor to look for when parsing GraphQL strings. Defaults to graphql.

Defined in: packages/graphql-tag-pluck/src/index.ts:85


modules#

Optional modules: { identifier?: string ; name: string }[]

Additional options for determining how a file is parsed.An array of packages that are responsible for exporting the GraphQL string parser function. The following modules are supported by default:

{
modules: [
{
// import gql from 'graphql-tag'
name: 'graphql-tag',
},
{
name: 'graphql-tag.macro',
},
{
// import { graphql } from 'gatsby'
name: 'gatsby',
identifier: 'graphql',
},
{
name: 'apollo-server-express',
identifier: 'gql',
},
{
name: 'apollo-server',
identifier: 'gql',
},
{
name: 'react-relay',
identifier: 'graphql',
},
{
name: 'apollo-boost',
identifier: 'gql',
},
{
name: 'apollo-server-koa',
identifier: 'gql',
},
{
name: 'apollo-server-hapi',
identifier: 'gql',
},
{
name: 'apollo-server-fastify',
identifier: 'gql',
},
{
name: ' apollo-server-lambda',
identifier: 'gql',
},
{
name: 'apollo-server-micro',
identifier: 'gql',
},
{
name: 'apollo-server-azure-functions',
identifier: 'gql',
},
{
name: 'apollo-server-cloud-functions',
identifier: 'gql',
},
{
name: 'apollo-server-cloudflare',
identifier: 'gql',
},
];
}

Defined in: packages/graphql-tag-pluck/src/index.ts:81


skipIndent#

Optional skipIndent: boolean

Set to true in order to get the found documents as-is, without any changes indentation changes

Defined in: packages/graphql-tag-pluck/src/index.ts:104