UNPKG

graphql-lattice/docs/SyntaxTree.js.html

Version:
1<!DOCTYPE html>
2<html lang="en">
3<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <title>SyntaxTree.js - Documentation</title>
7
  <script src="scripts/prettify/prettify.js"></script>
  <script src="scripts/prettify/lang-css.js"></script>
  <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  <![endif]-->
  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16</head>
17<body>
18
19<input type="checkbox" id="nav-trigger" class="nav-trigger" />
20<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
22</label>
23
24<label for="nav-trigger" class="overlay"></label>
25
26<nav>
  <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580asyncFn">⌾⠀asyncFn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580setPromise">⌾⠀setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html#setPromise">setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Deferred_exports.Deferred.html">Deferred</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DirectTypeAdd.html">DirectTypeAdd</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="FunctionExecutionError_FunctionExecutionError.html">FunctionExecutionError</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.html">GQLBase</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.apiDocs">apiDocs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getMergedRoot">⌾⠀getMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580IDLFilePath">⌾⠀IDLFilePath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580MUTATORS">⌾⠀MUTATORS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580RESOLVERS">⌾⠀RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580setupModel">⌾⠀setupModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580handler">⬇︎⠀handler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580SCHEMA">⬇︎⠀SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580applyAutoProps">⌾⠀applyAutoProps</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580callProp">⌾⠀callProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580extendModel">⌾⠀extendModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getModel">⌾⠀getModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580setModel">⌾⠀setModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580requestData">⬆︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580requestData">⬇︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~deleteProperty">deleteProperty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~set">set</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLEnum.html">GQLEnum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..get">.get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..set">.set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.valueFor">valueFor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580enums">⬇︎⠀enums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580name">⬇︎⠀name</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580value">⬇︎⠀value</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580values">⬇︎⠀values</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#GenerateEnumsProxyHandler">GenerateEnumsProxyHandler</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.clearCache">clearCache</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.%25E2%258C%25BE%25E2%25A0%2580generateSchemaSDL">⌾⠀generateSchemaSDL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#astMiddleware">astMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#schemaMiddleware">schemaMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%258C%25BE%25E2%25A0%2580customMiddleware">⌾⠀customMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middleware">⬇︎⠀middleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middlewareWithoutGraphiQL">⬇︎⠀middlewareWithoutGraphiQL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580schema">⬇︎⠀schema</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLInterface.html">GQLInterface</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLInterface.html#.%25E2%258C%25BE%25E2%25A0%2580resolveType">⌾⠀resolveType</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLScalar.html">GQLScalar</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseLiteral">parseLiteral</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseValue">parseValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.serialize">serialize</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.html">IDLFileHandler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getFile">⌾⠀getFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSchema">⌾⠀getSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSyntaxTree">⌾⠀getSyntaxTree</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.html">ModuleParser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580arrayToPattern">⌾⠀arrayToPattern</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580checkForPackageExtensions">⌾⠀checkForPackageExtensions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580findGQLBaseClasses">⌾⠀findGQLBaseClasses</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580importClass">⌾⠀importClass</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parse">⌾⠀parse</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parseSync">⌾⠀parseSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walk">⌾⠀walk</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walkSync">⌾⠀walkSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SchemaUtils.html">SchemaUtils</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580createMergedRoot">⌾⠀createMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectComments">⌾⠀injectComments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectEnums">⌾⠀injectEnums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectInterfaceResolvers">⌾⠀injectInterfaceResolvers</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectScalars">⌾⠀injectScalars</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SyntaxTree.html">SyntaxTree</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyDocument">⌾⠀EmptyDocument</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyMutation">⌾⠀EmptyMutation</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyQuery">⌾⠀EmptyQuery</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findDefinition">⌾⠀findDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findField">⌾⠀findField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findInASTArrayByNameValue">⌾⠀findInASTArrayByNameValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580from">⌾⠀from</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromAST">⌾⠀fromAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromSchema">⌾⠀fromSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580appendDefinitions">⌾⠀appendDefinitions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580consumeDefinition">⌾⠀consumeDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580find">⌾⠀find</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580findEnumDefinition">⌾⠀findEnumDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580setAST">⌾⠀setAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580toString">⌾⠀toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580updateAST">⌾⠀updateAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580ast">⬆︎⠀ast</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580ast">⬇︎⠀ast</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="utils.Deferred.html">Deferred</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="decorators.html">decorators</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#.%25E2%258C%25BE%25E2%25A0%2580extractBits">⌾⠀extractBits</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580AdjacentSchema">.🏷⠀AdjacentSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580FileSchema">.🏷⠀FileSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Getters">.🏷⠀Getters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Properties">.🏷⠀Properties</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Schema">.🏷⠀Schema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Setters">.🏷⠀Setters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#~decorate">decorate</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="GQLBaseEnv.html">GQLBaseEnv</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBaseEnv.html#~notDefined">notDefined</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#applyTags">applyTags</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#AsyncFunctionExecutionError">AsyncFunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_API_DOCS">CHECK_API_DOCS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_RESOLVERS">CHECK_RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_SCHEMA">CHECK_SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECKLIST">CHECKLIST</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#FunctionExecutionError">FunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getChecklist">getChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#hasChecklist">hasChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#newChecklist">newChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setChecklist">setChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#types">types</a></span></li>
28</nav>
29
30<div id="main">
  
  <h1 class="page-title">SyntaxTree.js</h1>
  
34
  
36
37
38
  
  <section>
      <article>
          <pre class="prettyprint source linenums"><code>// @flow
43// @module SyntaxTree
44
45import { typeOf } from 'ne-types'
46import { print, parse } from 'graphql'
47import { merge } from 'lodash'
48import { LatticeLogs as ll } from './utils'
49
50import type { GraphQLObjectType } from 'graphql/type/definition'
51import type {
ObjectTypeDefinitionNode,
InterfaceTypeDefinitionNode,
EnumTypeDefinitionNode,
UnionTypeDefinitionNode,
FieldDefinitionNode,
TypeDefinitionNode,
TypeNode
59} from 'graphql/language/ast'
60
61
62// Shorthand for the key storing the internal AST
63// @prop
64const AST_KEY = Symbol.for('Internal AST Storage Key');
65
66/**
* A parser and processor of GraphQL IDL Abstract Syntax Trees. Used to combine
* a set of {@link GQLBase} class instances.
*
* @class SyntaxTree
*/
72export class SyntaxTree
73{
/**
 * Constructs a new `SyntaxTree` object. If a string schema is supplied or
 * an already parsed AST object, either of which is valid GraphQL IDL, then
 * its parsed AST will be the internals of this object.
 *
 * @constructor
 * @memberof SyntaxTree
 * @method ⎆⠀constructor
 *
 * @param {string|Object|SyntaxTree} schemaOrASTOrST if supplied the tree
 * will be constructed with the contents of the data. If a string of IDL is
 * given, it will be parsed. If an AST is given, it will be verified. If a
 * SyntaxTree is supplied, it will be copied.
 */
constructor(schemaOrASTOrST?: string | Object | SyntaxTree) {
  // $ComputedType
  this[AST_KEY] = {};
91
  if (schemaOrASTOrST) {
    this.setAST(schemaOrASTOrST);
  }
}
96
/**
 * Getter that retrieves the abstract syntax tree created by `graphql.parse`
 * when it is presented with a valid string of IDL.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⬇︎⠀ast
 *
 * @return {Object} a GraphQL AST object
 */
get ast(): Object {
  // $ComputedType
  return this[AST_KEY];
}
111
/**
 * Setter that assigns the abstract syntax tree, typically created by
 * `graphql.parse` when given a valid string of IDL.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⬆︎⠀ast
 *
 * @param {Object} value a valid AST object. Other operations will act
 * in an undefined manner should this object not be a valid AST
 */
set ast(value: Object): void {
  // $ComputedType
  this[AST_KEY] = value;
}
127
/**
 * Sets the underlying AST object with either schema which will be parsed
 * into a valid AST or an existing AST. Previous ast values will be erased.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⌾⠀setAST
 *
 * @param {string|Object} schemaOrAST a valid GraphQL IDL schema or a
 * previosuly parsed or compatible GraphQL IDL AST object.
 * @return {SyntaxTree} this for inlining.
 */
setAST(schemaOrASTOrST: string|Object|SyntaxTree): SyntaxTree {
  // $ComputedType
  this[AST_KEY] = {};
143
  const type = typeOf(schemaOrASTOrST);
  let ast: Object;
  let st: SyntaxTree;
147
  switch (type) {
    case String.name:
      try {
        ast = parse((schemaOrASTOrST: any));
152
        merge(this.ast, ast);
      }
      catch (ignore) { /* Ignore this error */ }
156
      break;
    case Object.name:
      ast = (schemaOrASTOrST: any);
160
      try {
        ast = parse(print(ast));
        merge(this.ast, ast);
      }
      catch (ignore) { /* Ignore this error */ }
166
      break;
    case SyntaxTree.name:
      st = (schemaOrASTOrST: any);
170
      merge(this.ast, st.ast);
172
      break;
  }
175
  return this;
}
178
/**
 * As passthru update method that works on the internal AST object. If
 * an error occurs, the update is skipped. An error can occur if adding the
 * changes would make the AST invalid. In such a case, the error is logged
 * to the error console.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⌾⠀updateAST
 *
 * @param {Object} ast an existing GraphQL IDL AST object that will be
 * merged on top of the existing tree using _.merge()
 * @return {SyntaxTree} this for inlining.
 */
updateAST(ast: Object): SyntaxTree {
  if (typeOf(ast) === Object.name) {
    let newAST = merge({}, this.ast, ast);
196
    try {
      print(newAST);
      this.ast = merge(this.ast, ast);
    }
    catch (error) {
      ll.error('[SyntaxTree] Failed to updateAST with %o', ast);
      ll.error('Resulting object would be %o', newAST);
      ll.error(error);
    }
  }
207
  return this;
}
210
/**
 * Appends all definitions from another AST to this one. The method will
 * actually create a copy using SyntaxTree.from() so the input types can
 * be any one of a valid GraphQL IDL schema string, a GraphQL IDL AST or
 * another SyntaxTree object instance.
 *
 * Definitions of the same name but different kinds will be replaced by the
 * new copy. Those of the same kind and name will be merged (TODO handle more
 * than ObjectTypeDefinition kinds when merging; currently other types are
 * overwritten).
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⌾⠀appendDefinitions
 *
 * @param {string|Object|SyntaxTree} schemaOrASTOrST an instance of one of
 * the valid types for SyntaxTree.from() that can be used to create or
 * duplicate the source from which to copy definitions.
 * @return {SyntaxTree} this for inlining
 */
appendDefinitions(schemaOrASTOrST: string | Object | SyntaxTree): SyntaxTree {
  const source = SyntaxTree.from(schemaOrASTOrST);
  const set = new Set();
234
  this.ast.definitions.map((definition) => {
    set.add(definition.name.value);
  })
238
  if (source &amp;&amp; source.ast.definitions &amp;&amp; this.ast.definitions) {
    for (let theirs of (source: any)) {
      let name = theirs.name.value;
      let ours = this.find(name);
      let index = ours &amp;&amp; this.ast.definitions.indexOf(ours) || -1;
244
      // We don't yet have one with that name
      if (!set.has(name)) {
        set.add(name);
        this.ast.definitions.push(theirs);
      }
250
      // We do have one with that name
      else {
        // The kinds aren't the same, just replace theirs with ours
        if (theirs.kind !== ours.kind) {
          // replace with the new one
          this.ast.definitions[index] = theirs;
        }
258
        // The kinds are the same, lets just merge their fields
        else {
          // merge the properties of the same types.
          switch (theirs.kind) {
            case 'ObjectTypeDefinition':
              ours.interfaces = [].concat(ours.interfaces, theirs.interfaces)
              ours.directives = [].concat(ours.directives, theirs.directives)
              ours.fields = [].concat(ours.fields, theirs.fields)
              break;
            default:
              // Since we don't support other types yet. Let's replace
              this.ast.definitions[index] = theirs;
              break;
          }
        }
      }
    }
  }
277
  return this;
}
280
/**
 * This method finds the Query type definitions in the supplied AST or
 * SyntaxTree objects, takes its defined fields and adds it to the current
 * instances. If this instance does not have a Query type defined but the
 * supplied object does, then the supplied one is moved over. If neither
 * has a query handler, then nothing happens.
 *
 * NOTE this *removes* the Query type definition from the supplied AST or
 * SyntaxTree object.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⌾⠀consumeDefinition
 *
 * @param {Object|SyntaxTree} astOrSyntaxTree a valid GraphQL IDL AST or
 * an instance of SyntaxTree that represents one.
 * @param {string|RegExp} definitionType a valid search input as would be
 * accepted for the #find() method of this object.
 * @return {SyntaxTree} returns this for inlining
 */
consumeDefinition(
  astOrSyntaxTree: Object | SyntaxTree,
  definitionType: string | RegExp = "Query"
): SyntaxTree {
  if (!astOrSyntaxTree || !this.ast || !this.ast.definitions) { return this }
306
  const tree = typeOf(SyntaxTree) === SyntaxTree.name
    ? astOrSyntaxTree
    : SyntaxTree.from(astOrSyntaxTree);
  let left = this.find(definitionType);
  let right = tree &amp;&amp; tree.find(definitionType) || null;
312
  if (!tree) {
    ll.error('There seems to be something wrong with your tree')
    ll.error(new Error('Missing tree; continuing...'));
    return this;
  }
318
  if (!right) { return this }
320
  if (!left) {
    this.ast.definitions.push(right);
323
    // Remove the copied definition from the source
    tree.ast.definitions.splice(tree.ast.definitions.indexOf(right), 1);
326
    return this;
  }
329
  // TODO support other types aside from ObjectTypeDefinitions
  // TODO see if there is a better way to achieve this with built-in
  // graphql code someplace
  switch(left.kind) {
    case 'ObjectTypeDefinition':
      if (left.interfaces &amp;&amp; right.interfaces) {
        left.interfaces = [].concat(left.interfaces, right.interfaces);
      }
338
      if (left.directives &amp;&amp; right.directives) {
        left.directives = [].concat(left.directives, right.directives);
      }
342
      if (left.fields &amp;&amp; right.fields) {
        left.fields = [].concat(left.fields, right.fields);
      }
346
      break;
    default:
      break;
  }
351
  // Remove the copied definition from the source
  tree.ast.definitions.splice(tree.ast.definitions.indexOf(right), 1);
354
  return this;
}
357
/**
 * When iterating over an instance of SyntaxTree, you are actually
 * iterating over the definitions of the SyntaxTree if there are any;
 *
 * @instance
 * @memberof SyntaxTree
 * @method *[Symbol.iterator]
 *
 * @return {TypeDefinitionNode} an instance of a TypeDefinitionNode; see
 * graphql/language/ast.js.flow for more information
 * @ComputedType
 */
*[Symbol.iterator](): TypeDefinitionNode {
  if (this[AST_KEY].definitions) {
    return yield* this[AST_KEY].definitions;
  }
  else {
    return yield* this;
  }
}
378
/**
 * Getter that builds a small outline object denoting the schema being
 * processed. If you have a schema that looks like the following:
 *
 * ```javascript
 * let st = SyntaxTree.from(`
 *   type Contrived {
 *     name: String
 *     age: Int
 *   }
 *
 *   type Query {
 *     getContrived: Contrived
 *   }
 * `)
 * let outline = st.outline
 * ```
 *
 * You will end up with an object that looks like the following:
 *
 * ```javascript
 * {
 *   Contrived: { name: 'String', age: 'Int' },
 *   Query: { getContrived: 'Contrived' }
 * }
 * ```
 *
 * As may be evidenced by the example above, the name of the type is
 * represented by an object where the name of each field (sans arguments)
 * is mapped to a string denoting the type.
 */
get outline(): Object {
  let outline = {}
  let interfaces = Symbol.for('interfaces')
413
  // $FlowFixMe
  for (let definition of this) {
    let out
417
    switch (definition.kind) {
      case 'InterfaceTypeDefinition':
      case 'ObjectTypeDefinition':
        out = outline[definition.name.value] = {}
        definition.fields.forEach(
          field => {
            if (field.type.kind === 'NamedType')
              out[field.name.value] = field.type.name.value
            else if (field.type.kind === 'ListType')
              out[field.name.value] = field.type.type.name.value
          }
        )
430
        if (definition.interfaces) {
          // $FlowFixMe
          out = (out[interfaces] = out[interfaces] || [])
434
          definition.interfaces.forEach(
            _interface => out.push(_interface.name.value)
          )
        }
439
        break;
441
      case 'EnumTypeDefinition':
        out = outline[definition.name.value] = []
        definition.values.forEach(
          value => out[value.name.value] = value.name.value
        )
        break;
448
      case 'UnionTypeDefinition':
        out = outline[definition.name.value] = []
        definition.types.forEach(
          type => out.push(type.name.value)
        )
        break;
    }
  }
457
  return outline
}
460
/**
 * Iterate through the definitions of the AST if there are any. For each
 * definition the name property's value field is compared to the supplied
 * definitionName. The definitionName can be a string or a regular
 * expression if finer granularity is desired.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⌾⠀find
 *
 * @param {string|RegExp} definitionName a string or regular expression used
 * to match against the definition name field in a given AST.
 * @return {Object|null} a reference to the internal definition field or
 * null if one with a matching name could not be found.
 */
find(definitionName: string|RegExp): Object | null {
  // $ComputedType
  return SyntaxTree.findDefinition(this[AST_KEY], definitionName);
}
480
/**
 * SyntaxTree instances that are toString()'ed will have the graphql method
 * print() called on them to convert their internal structures back to a
 * GraphQL IDL schema syntax. If the object is in an invalid state, it WILL
 * throw an error.
 *
 * @instance
 * @memberof SyntaxTree
 * @method ⌾⠀toString
 *
 * @return {string} the AST for the tree parsed back into a string
 */
toString(): string {
  // $ComputedType
  return print(this[AST_KEY]);
}
497
/**
 * A runtime constant denoting a query type.
 *
 * @type {string}
 * @static
 * @memberof SyntaxTree
 * @method ⬇︎⠀QUERY
 * @readonly
 * @const
 */
static get QUERY(): string { return 'Query' }
509
/**
 * A runtime constant denoting a mutation type.
 *
 * @type {string}
 * @static
 * @memberof SyntaxTree
 * @method ⬇︎⠀MUTATION
 * @readonly
 * @const
 */
static get MUTATION(): string { return 'Mutation' }
521
  /**
 * A runtime constant denoting a subscription type.
 *
 * @type {string}
 * @static
 * @memberof SyntaxTree
 * @method SUBSCRIPTION
 * @readonly
 * @const
 */
static get SUBSCRIPTION(): string { return 'Subscription' }
533
/**
 * Returns the `constructor` name. If invoked as the context, or `this`,
 * object of the `toString` method of `Object`'s `prototype`, the resulting
 * value will be `[object MyClass]`, given an instance of `MyClass`
 *
 * @method ⌾⠀[Symbol.toStringTag]
 * @memberof SyntaxTree
 *
 * @return {string} the name of the class this is an instance of
 * @ComputedType
 */
get [Symbol.toStringTag]() { return this.constructor.name }
546
/**
 * Applies the same logic as {@link #[Symbol.toStringTag]} but on a static
 * scale. So, if you perform `Object.prototype.toString.call(MyClass)`
 * the result would be `[object MyClass]`.
 *
 * @method ⌾⠀[Symbol.toStringTag]
 * @memberof SyntaxTree
 * @static
 *
 * @return {string} the name of this class
 * @ComputedType
 */
static get [Symbol.toStringTag]() { return this.name }
560
/**
 * Given one of, a valid GraphQL IDL schema string, a valid GraphQL AST or
 * an instance of SyntaxTree, the static from() method will create a new
 * instance of the SyntaxTree with the values you provide.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀from
 *
 * @param {String|Object|SyntaxTree} mixed an instance of one of the valid
 * types specified above. Everything else will result in a null value.
 * @return {SyntaxTree} a newly created and populated instance of SyntaxTree
 * or null if an invalid type was supplied for mixed.
 */
static from(mixed: string | Object | SyntaxTree): SyntaxTree | null {
  let schema: string;
  let ast: Object;
578
  switch (typeOf(mixed)) {
    case String.name:
      schema = (mixed: any);
      try { parse(schema) } catch(error) { ll.error(error); return null; }
583
      return SyntaxTree.fromSchema(String(schema));
    case Object.name:
      ast = (mixed: any);
      try { print(ast) } catch(error) { return null; }
588
      return SyntaxTree.fromAST(ast);
    case SyntaxTree.name:
      schema = mixed.toString();
592
      return SyntaxTree.from(schema);
    default:
      return null;
  }
}
598
/**
 * Generates a new instance of SyntaxTree from the supplied, valid, GraphQL
 * schema. This method does not perform try/catch validation and if an
 * invalid GraphQL schema is supplied an error will be thrown.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀fromSchema
 *
 * @param {string} schema a valid GraphQL IDL schema string.
 * @return {SyntaxTree} a new instance of SyntaxTree initialized with a
 * parsed response from require('graphql').parse().
 */
static fromSchema(schema: string): SyntaxTree {
  const ast = parse(schema);
  let tree = new SyntaxTree(ast);
615
  return tree;
}
618
/**
 * Generates a new instance of SyntaxTree from the supplied, valid, GraphQL
 * schema. This method does not perform try/catch validation and if an
 * invalid GraphQL schema is supplied an error will be thrown.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀fromAST
 *
 * @param {object} ast a valid GraphQL AST object.
 * @return {SyntaxTree} a new instance of SyntaxTree initialized with a
 * supplied abstract syntax tree generated by require('graphql').parse() or
 * other compatible method.
 */
static fromAST(ast: Object): SyntaxTree | null {
  const source = parse(print(ast));
  let tree = new SyntaxTree(source);
636
  return source ? tree : null;
}
639
/**
 * Iterate through the definitions of the AST if there are any. For each
 * definition the name property's value field is compared to the supplied
 * definitionName. The definitionName can be a string or a regular
 * expression if finer granularity is desired.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀findDefinition
 *
 * @param {Object} ast an abstract syntax tree object created from a GQL SDL
 * @param {string|RegExp} definitionName a string or regular expression used
 * to match against the definition name field in a given AST.
 * @return {Object|null} a reference to the internal definition field or
 * null if one with a matching name could not be found.
 */
static findDefinition(ast: Object, definitionName: string | RegExp) {
  return this.findInASTArrayByNameValue(
    ast.definitions,
    definitionName
  );
}
662
/**
 * Iterate through the fields of a definition AST if there are any. For each
 * field, the name property's value field is compared to the supplied
 * fieldName. The fieldName can be a string or a regular expression if
 * finer granularity is desired.
 *
 * Before iterating over the fields, however, the definition is found using
 * `SyntaxTree#findDefinition`. If either the field or definition are not
 * found, null is returned.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀findField
 * @since 2.7.0
 *
 * @param {Object} ast an abstract syntax tree object created from a GQL SDL
 * @param {string|RegExp} definitionName a string or regular expression used
 * to match against the definition name field in a given AST.
 * @param {string|RegExp} fieldName a string or regular expression used
 * to match against the field name field in a given AST.
 * @return {Object|null} an object containing two keys, the first being
 * `field` which points to the requested AST definition field. The second
 * being `meta` which contains three commonly requested bits of data; `name`,
 * `type` and `nullable`. Non-nullable fields have their actual type wrapped
 * in a `NonNullType` GraphQL construct. The actual field type is contained
 * within. The meta object surfaces those values for easy use.
 */
static findField(
  ast: Object,
  definitionName: string | RegExp,
  fieldName: string | RegExp
) {
  const definition = this.findDefinition(ast, definitionName)
  let meta;
697
  if (!definition || !definition.fields) {
    return null;
  }
701
  const field = this.findInASTArrayByNameValue(definition.fields, fieldName)
703
  if (field) {
    meta = {
      name: field.name &amp;&amp; field.name.value || null,
      type: field.type &amp;&amp; field.type.kind === 'NonNullType'
        ? field.type.type.name.value
        : field.type &amp;&amp; field.type.name &amp;&amp; field.type.name.value || null,
      nullable: !!(field.type &amp;&amp; field.type.kind !== 'NonNullType')
    }
  }
713
  return { field, meta };
}
716
/**
 * Enum AST definitions operate differently than object type definitions
 * do. Namely, they do not have a `fields` array but instead have a `values`
 * array. This wrapper method, first finds the enum definition in the ast
 * and then searches the values for the named node desired and returns that
 * or null, if one could not be found.
 *
 * @method SyntaxTree#⌾⠀findEnumDefinition
 * @since 2.7.0
 *
 * @param {Object} ast the abstract syntax tree parsed by graphql
 * @param {string|RegExp} enumDefinitionName a string or regular expression
 * used to locate the enum definition in the AST.
 * @param {string|RegExp} enumValueName a string or regular expression used
 * to locate the value by name in the values of the enum definition.
 * @return {Object|null} the desired AST node or null if one does not exist
 */
static findEnumDefinition(
  ast: Object,
  enumDefinitionName: string | RegExp,
  enumValueName: string | RegExp
): ?Object {
  // Fetch the enum definition
  const definition = this.findDefinition(ast, enumDefinitionName);
741
  // Ensure we have one or that it has a values array
  if (!definition || !definition.values) {
    return null;
  }
746
  // Return the results of an `findInASTArrayByNameValue()` search of the
  // aforementioned 'values' array.
  return this.findInASTArrayByNameValue(
    definition.values,
    enumValueName
  )
}
754
/**
 * A lot of searching in ASTs is filtering through arrays and matching on
 * subobject properties on each iteration. A common theme is find something
 * by its `.name.value`. This method simplifies that by taking an array of
 * AST nodes and searching them for a `.name.value` property that exists
 * within.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀findInASTArrayByNameValue
 * @since 2.7.0
 *
 * @param {Array} array of mixed AST object nodes containing `name.value`s
 * @param {string|RegExp} name a string or regular expression used
 * to match against the node name value
 * @return {Object|null} the AST leaf if one matches or null otherwise.
 */
static findInASTArrayByNameValue(
  array: Array&lt;Object>,
  name: string | RegExp
): ?Object {
  const isRegExp: boolean = /RegExp/.test(typeOf(name));
  const regex = !isRegExp
    // $FlowFixMe
    ? new RegExp(RegExp.escape(name.toString()))
    // $FlowFixMe
    : (name: RegExp);
  const flags = regex.flags
  const source = regex.source
  const reducer = (last,cur,i) => {
    if (last !== -1) return last;
    if (!cur || !cur.name || !cur.name.value) return -1;
    return new RegExp(source, flags).test(cur.name.value) ? i : -1
  }
  const index = array.reduce(reducer, -1);
790
  return (~index) ? array[index] : null;
}
793
/**
 * Query types in GraphQL are an ObjectTypeDefinition of importance for
 * placement on the root object. There is utility in creating an empty
 * one that can be injected with the fields of other GraphQL object query
 * entries.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀EmptyQuery
 *
 * @return {SyntaxTree} an instance of SyntaxTree with a base AST generated
 * by parsing the graph query, "type Query {}"
 */
static EmptyQuery(): ?SyntaxTree {
  return SyntaxTree.from(`type ${this.QUERY} {}`);
}
810
/**
 * Mutation types in GraphQL are an ObjectTypeDefinition of importance for
 * placement on the root object. There is utility in creating an empty
 * one that can be injected with the fields of other GraphQL object mutation
 * entries.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀EmptyMutation
 *
 * @return {SyntaxTree} an instance of SyntaxTree with a base AST generated
 * by parsing the graph query, "type Mutation {}"
 */
static EmptyMutation(): ?SyntaxTree {
  return SyntaxTree.from(`type ${this.MUTATION} {}`);
}
827
/**
 * The starting point for a SyntaxTree that will be built up programmatically.
 *
 * @static
 * @memberof SyntaxTree
 * @method ⌾⠀EmptyDocument
 *
 * @param {string|Object|SyntaxTree} schemaOrASTOrST any valid type taken by
 * SyntaxTree.from() used to further populate the new empty document
 * @return {SyntaxTree} an instance of SyntaxTree with no definitions and a
 * kind set to 'Document'
 */
static EmptyDocument(
  schemaOrASTOrST?: string | Object | SyntaxTree
): SyntaxTree {
  let tree = new SyntaxTree();
844
  // Due to normal validation methods with ASTs (i.e. converting to string
  // and then back to an AST object), doing this with an empty document
  // fails. Therefore, we manually set the document contents here. This allows
  // toString(), consumeDefinition() and similar methods to still work.
  tree.ast = {
    kind: 'Document',
    definitions: [],
    loc: {start: 0, end: 0}
  };
854
  if (schemaOrASTOrST) {
    tree.appendDefinitions(schemaOrASTOrST);
  }
858
  return tree;
}
861}
862
863export default SyntaxTree;
864</code></pre>
      </article>
  </section>
867
868
869
870
871</div>
872
873<br class="clear">
874
875<footer>
  Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jun 08 2018 19:28:39 GMT-0700 (PDT) using the Minami theme.
877</footer>
878
879<script>prettyPrint();</script>
880<script src="scripts/linenumber.js"></script>
881</body>
882</html>