Registry / devops / apollo-utilities

apollo-utilities

library1.3.4jsnpmunverified

A library of utility functions for working with GraphQL ASTs, used by Apollo Client packages. Current stable version is 1.3.4. Maintenance mode since Apollo Client 3.x internalized these utilities. Key differentiators: provides commonly needed functions like getMainDefinition, getFragmentDefinitions, and createFragmentMap that simplify GraphQL AST manipulation. Primarily used internally by Apollo Client ecosystem.

devops

npm install apollo-utilities

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · APOLLO-UTILITIES

apollo-utilities

devopsjavascriptv1.3.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

getMainDefinition

✓ import { getMainDefinition } from 'apollo-utilities'

✗ const getMainDefinition = require('apollo-utilities').getMainDefinition

ESM import recommended.

storeKeyNameFromField

✓ import { storeKeyNameFromField } from 'apollo-utilities'

Named export, no default.

createFragmentMap

✓ import { createFragmentMap } from 'apollo-utilities'

✗ import { createFragmentMap } from 'apollo-utilities/src/index'

Avoid source file imports; use package entry.

Demonstrates parsing a GraphQL query and extracting main definition and fragment map.

import { getMainDefinition, getFragmentDefinitions, createFragmentMap } from 'apollo-utilities'; import { parse } from 'graphql'; const query = ` query GetUser { user { id name posts { title } } } `; const document = parse(query); const mainDef = getMainDefinition(document); console.log(mainDef.kind); // 'OperationDefinition' const fragmentDefs = getFragmentDefinitions(document); const fragmentMap = createFragmentMap(fragmentDefs); console.log(Object.keys(fragmentMap)); // []

Debug

Known issues

deprecatedapollo-utilities is deprecated in favor of @apollo/client/utilities

fix

Migrate to importing from '@apollo/client/utilities' instead.

affects: 1.3.x

breakingIn Apollo Client 3.x, this package is no longer published separately and utilities are internal.

fix

If using Apollo Client 3+, import utilities from '@apollo/client/utilities'.

affects: >=3.0.0

gotchaRequires graphql to be installed as a peer dependency; missing graphql will cause runtime errors.

fix

npm install graphql

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'apollo-utilities'

Package not installed or removed in newer Apollo Client versions.

fix

npm install apollo-utilities or use '@apollo/client/utilities'.

TypeError: Object(...) is not a function (e.g., getMainDefinition)

Importing from wrong path or using default import instead of named.

fix

Use named imports: import { getMainDefinition } from 'apollo-utilities'.

Upgrade

Version history

1.3.4latest on npm

Audit

Dependencies

graphqlrequiredpeer dependency for AST manipulation

Agent activity

14 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/apollographql/apollo-client ↗

packageapollo-utilities ↗

homepagehttps://github.com/apollographql/apollo-client#readme ↗