@apollo/client
Version:
A fully-featured caching GraphQL client.
62 lines (61 loc) • 2.17 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.getMainDefinition = getMainDefinition;
const invariant_1 = require("@apollo/client/utilities/invariant");
const checkDocument_js_1 = require("./checkDocument.cjs");
/**
* Returns the first operation definition from a GraphQL document. The function
* prioritizes operation definitions over fragment definitions, which makes it
* suitable for documents that may contain both. If no operation definition is
* found, the first fragment definition will be returned. If no definitions are
* found, an error is thrown.
*
* @remarks
*
* Use this function when you need to perform more advanced tasks with the main
* definition AST node. If you want to determine when a document is a specific
* operation type, prefer the `isQueryOperation`, `isMutationOperation`, and
* `isSubscriptionOperation` utility functions instead.
*
* @param queryDoc - The GraphQL document to extract the definition from
* @returns The main operation or fragment definition AST node
*
* @example
*
* ```ts
* import { gql } from "@apollo/client";
* import { getMainDefinition } from "@apollo/client/utilities";
*
* const query = gql`
* query GetUser($id: ID!) {
* user(id: $id) {
* name
* email
* }
* }
* `;
*
* const definition = getMainDefinition(query);
* ```
*
* @throws When the document contains no operation or fragment definitions
*/
function getMainDefinition(queryDoc) {
(0, checkDocument_js_1.checkDocument)(queryDoc);
let fragmentDefinition;
for (let definition of queryDoc.definitions) {
if (definition.kind === "OperationDefinition") {
return definition;
}
if (definition.kind === "FragmentDefinition" && !fragmentDefinition) {
// we do this because we want to allow multiple fragment definitions
// to precede an operation definition.
fragmentDefinition = definition;
}
}
if (fragmentDefinition) {
return fragmentDefinition;
}
throw (0, invariant_1.newInvariantError)(12);
}
//# sourceMappingURL=getMainDefinition.cjs.map