UNPKG

graphql-lattice/docs/GQLBase.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>GQLBase.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">GQLBase.js</h1>
  
34
  
36
37
38
  
  <section>
      <article>
          <pre class="prettyprint source linenums"><code>/** @namespace GQLBaseEnv */
43// @flow
44
45import Path from 'path'
46import fs from 'fs'
47
48import { Deferred, joinLines } from './utils'
49import { typeOf } from 'ne-types'
50import { SyntaxTree } from './SyntaxTree'
51import { Properties } from './decorators/ModelProperties'
52import { GraphQLObjectType, GraphQLEnumType } from 'graphql'
53import { IDLFileHandler } from './IDLFileHandler'
54import { merge } from 'lodash'
55import { LatticeLogs as ll } from './utils'
56import { dedent } from 'ne-tag-fns'
57
58import AsyncFunctionExecutionError from './errors/AsyncFunctionExecutionError'
59import FunctionExecutionError from './errors/FunctionExecutionError'
60import AwaitingPromiseError from './errors/AwaitingPromiseError'
61
62import EventEmitter from 'events'
63
64/* Internal implementation to detect the existence of proxies. When present
* additional functionality is enabled. Proxies are native in Node >= 6 */
66const hasProxy = typeof global.Proxy !== 'undefined';
67
68/* Internal Symbol referring to real accessor to GQLBase model object */
69const _MODEL_KEY = Symbol.for('data-model-contents-value');
70
71/* Internal Symbol referring to the static object containing a proxy handler */
72const _PROXY_HANDLER = Symbol.for('internal-base-proxy-handler')
73
74/**
* Simple function to check if a supplied key matches a string of your
* choosing and that string is not a defined property on the instance
* passed to the check.
*
* @method GQLBaseEnv~notDefined
* @memberof GQLBaseEnv
* @since 2.5.0
*
* @param {string} keyToTest a String denoting the property you wish to test
* @param {mixed} keySupplied a value, coerced `toString()`, to compare to
* `keyToTest`
* @param {mixed} instance an object instance to check `hasOwnProperty` on for
* the `keyToTest` supplied.
* @return {Boolean} true if the property matches the supplied key and that
* property is not an ownedProperty of the instance supplied.
*/
91export function notDefined(
keyToTest: string,
keySupplied: Object | string,
instance: Object
95) {
return (
  new RegExp("^" + keyToTest + "$").test(keySupplied.toString())
  &amp;&amp; !instance.hasOwnProperty(keyToTest)
);
100}
101
102/**
* A `Symbol` used as a key to store the backing model data. Designed as a
* way to separate model data and GraphQL property accessors into logical bits.
*
* @type {Symbol}
* @memberof GQLBaseEnv
* @const
*/
110export const MODEL_KEY = Symbol.for('data-model-contents-key');
111
112/**
* A `Symbol` used as a key to store the request data for an instance of the
* GQLBase object in question.
*
* @type {Symbol}
* @const
* @inner
* @memberof GQLBaseEnv
*/
121export const REQ_DATA_KEY = Symbol.for('request-data-object-key');
122
123/**
* A nameless Symbol for use as a key to the internal decorator storage
*
* @type {Symbol}
* @const
* @inner
* @memberof GQLBaseEnv
*/
131export const META_KEY = Symbol();
132
133/**
* A Symbol used to identify calls to @Properties for properties generated
* automatically upon instance creation.
*
* @type {Symbol}
* @const
* @inner
* @memberOf GQLBaseEnv
*/
142export const AUTO_PROPS = Symbol.for('auto-props')
143
144/**
* A Symbol used to identify calls to @Getters for properties generated
* via decorator. These are stored in &lt;class>[META_KEY][GETTERS]
*
* @type {Symbol}
* @const
* @inner
* @memberOf GQLBaseEnv
*/
153export const GETTERS = Symbol.for('getters')
154
155/**
* A Symbol used to identify calls to @Setters for properties generated
* via decorator. These are stored in &lt;class>[META_KEY][SETTERS]
*
* @type {Symbol}
* @const
* @inner
* @memberOf GQLBaseEnv
*/
164export const SETTERS = Symbol.for('setters')
165
166/**
* A Symbol used to identify calls to @Properties for properties generated
* via decorator. These are stored in &lt;class>[META_KEY][PROPS]
*
* @type {Symbol}
* @const
* @inner
* @memberOf GQLBaseEnv
*/
175export const PROPS = Symbol.for('props')
176
177/**
* All GraphQL Type objects used in this system are assumed to have extended
* from this class. An instance of this class can be used to wrap an existing
* structure if you have one.
*
* @class GQLBase
*/
184export class GQLBase extends EventEmitter {
fileHandler: ?IDLFileHandler;
186
/**
 * Request data is passed to this object when constructed. Typically these
 * objects, and their children, are instantiated by its own static MUTATORS
 * and RESOLVERS. They should contain request specific state if any is to
 * be shared.
 *
 * These can be considered request specific controllers for the object in
 * question. The base class takes a single object which should contain all
 * the HTTP/S request data and the graphQLParams is provided as the object
 * { query, variables, operationName, raw }.
 *
 * When used with express-graphql, the requestData object has the format
 * { req, res, gql } where
 *   • req is an Express 4.x request object
 *   • res is an Express 4.x response object
 *   • gql is the graphQLParams object in the format of
 *     { query, variables, operationName, raw }
 *     See https://github.com/graphql/express-graphql for more info
 *
 * @memberof GQLBase
 * @method ⎆⠀constructor
 * @constructor
 *
 * @param {mixed} modelData this, typically an object, although anything
 * really is supported, represents the model data for our GraphQL object
 * instance.
 * @param {Object} requestData see description above
 */
constructor(
  modelData: Object = {},
  requestData: ?Object = null,
  options: Object = { autoProps: true }
) {
  super();
221
  const Class = this.constructor;
  const tree = SyntaxTree.from(Class.SCHEMA);
  const outline = tree &amp;&amp; tree.outline || null;
225
  if (!outline) {
    throw new FunctionExecutionError(
      new Error(dedent`
        The SDL is unparsable. Please check your SCHEMA and make sure
        it is valid GraphQL SDL/IDL. Your SCHEMA is defined as:
231
        ${this.SCHEMA}
      `)
    )
  }
236
  if (outline &amp;&amp; !(Class.name in outline)) {
    throw new FunctionExecutionError(
      new Error(dedent`
        The class name "${Class.name}" does not match any of the types,
        enums, scalars, unions or interfaces defined in the SCHEMA for
        this class (${Object.keys(outline)}).
243
        \x1b[1mIn most clases this is because your class name and SCHEMA
        type do not match.\x1b[0m
      `)
    )
  }
249
  GQLBase.setupModel(this);
  this.setModel(modelData);
  this.requestData = requestData || {};
  this.fileHandler = new IDLFileHandler(this.constructor);
254
  if (options &amp;&amp; !!options.autoProps !== false) {
    this.applyAutoProps()
  }
258
  // @ComputedType
  return hasProxy ? new Proxy(this, GQLBase[_PROXY_HANDLER]) : this;
}
262
/**
 * Since reading the Schema for a given GraphQL Lattice type or
 * interface is simple enough, we should be able to automatically
 * apply one to one GraphQL:Model properties.
 *
 * @instance
 * @method ⌾⠀applyAutoProps
 * @memberof GQLBase
 */
applyAutoProps() {
  if (!this.constructor.SCHEMA || !this.constructor.SCHEMA.length) {
    ll.warn(joinLines`
      There is no SCHEMA for ${this.constructor.name}!! This will likely
      end in an error. Proceed with caution. Skipping \`applyAutoProps\`
    `)
    return
  }
280
  // Individual property getters do not need to be auto-created for enum
  // types. Potentially do some checks for Interfaces and Unions as well
  if (this.constructor.GQL_TYPE === GraphQLEnumType) {
    return
  }
286
  let Class = this.constructor
  let tree = SyntaxTree.from(Class.SCHEMA)
  let outline = tree ? tree.outline : {}
  let props = []
291
  // $FlowFixMe
  for (let propName of Object.keys(outline[Class.name])) {
    // $FlowFixMe
    let desc = Object.getOwnPropertyDescriptor(Class.prototype, propName)
    let hasCustomImpl = !!(
      // We have a descriptor for the property name
      desc &amp;&amp; (
        // We have a getter function defined
        typeof desc.get !== 'undefined'
        ||
        // ...or we have a function, async or not, defined
        typeof desc.value === 'function'
      )
    )
306
    // Only create auto-props for non custom implementations
    if (!hasCustomImpl) {
      props.push(propName)
    }
  }
312
  if (props.length) {
    ll.info(`Creating auto-props for [${Class.name}]: `, props)
    try {
      Properties(...props)(Class, [AUTO_PROPS])
    }
    catch(error) {
      let parsed = /Cannot redefine property: (\w+)/.exec(error.message)
      if (parsed) {
        ll.warn(`Skipping auto-prop '${Class.name}.${parsed[1]}'`)
      }
      else {
        ll.error(`Failed to apply auto-properties\nReason: `)
        ll.error(error);
      }
    }
  }
}
330
/**
 * Getter for the internally stored model data. The contents of this
 * object are abstracted away behind a `Symbol` key to prevent collision
 * between the underlying model and any GraphQL Object Definition properties.
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀getModel
 * @since 2.5
 *
 * @param {Object} value any object you wish to use as a data store
 */
getModel() {
  // @ComputedType
  return this[MODEL_KEY];
}
347
/**
 * Setter for the internally stored model data. The contents of this
 * object are abstracted away behind a `Symbol` key to prevent collision
 * between the underlying model and any GraphQL Object Definition properties.
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀setModel
 * @since 2.5
 *
 * @param {Object} value any object you wish to use as a data store
 */
setModel(value: Object): GQLBase {
  // @ComputedType
  this[MODEL_KEY] = value;
  return this;
}
365
/**
 * Uses `_.merge()` to modify the internal backing data store for the
 * object instance. This is a shortcut for
 * `_.merge()(instance[MODEL_KEY], ...extensions)`
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀extendModel
 * @since 2.5
 *
 * @param {mixed} extensions n-number of valid `_.merge()` parameters
 * @return {GQLBase} this is returned
 */
extendModel(...extensions: Array&lt;mixed>): GQLBase {
  // $FlowFixMe
  merge(this[MODEL_KEY], ...extensions);
  return this;
}
384
/**
 * A getter that retrieves the inner request data object. When used with
 * GQLExpressMiddleware, this is an object matching {req, res, gql}.
 *
 * @instance
 * @memberof GQLBase
 * @method ⬇︎⠀requestData
 *
 * @return {Object} an object, usually matching { req, res, gql }
 */
get requestData(): Object | null {
  // @ComputedType
  return this[REQ_DATA_KEY];
}
399
/**
 * A setter that assigns a value to the inner request data object. When
 * used with GQLExpressMiddleware, this is an object matching {req, res, gql}.
 *
 * @instance
 * @memberof GQLBase
 * @method ⬆︎⠀requestData
 *
 * @param {Object} value an object, usually matching { req, res, gql }
 */
set requestData(value: Object): void {
  // @ComputedType
  this[REQ_DATA_KEY] = value;
}
414
/**
 * 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 ModuleParser
 *
 * @return {string} the name of the class this is an instance of
 * @ComputedType
 */
get [Symbol.toStringTag]() { return this.constructor.name }
427
/**
 * Properties defined for GraphQL types in Lattice can be defined as
 * a getter, a function or an async function. In the case of standard
 * functions, if they return a promise they will be handled as though
 * they were async
 *
 * Given the variety of things a GraphQL type can actually be, obtaining
 * its value can annoying. This method tends to lessen that boilerplate.
 * Errors raised will be thrown.
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀getProp
 *
 * @param {string|Symbol} propName the name of the property in question
 * @param {boolean} bindGetters true, by default, if the `get` or
 * `initializer` descriptor values should be bound to the current instance
 * or an object of the programmers choice before returning
 * @param {mixed} bindTo the `this` object to use for binding when
 * `bindGetters` is set to true.
 * @return {mixed} the value of the `propName` as a Function or something
 * else when the requested property name exists
 *
 * @throws {Error} errors raised in awaiting results will be thrown
 */
getProp(propName: string, bindGetters: boolean = true, bindTo: mixed) {
  // $FlowFixMe
  let proto = Object.getPrototypeOf(this)
  let descriptor = Object.getOwnPropertyDescriptor(proto, propName)
  let result
458
  if (!descriptor) {
    return null;
  }
462
  if (descriptor) {
    if (descriptor.initializer || descriptor.get) {
      let what = descriptor.initializer || descriptor.get
466
      if (bindGetters) {
        result = what.bind(bindTo || this)
      }
      else {
        result = what
      }
    }
    else if (descriptor.value) {
      result = descriptor.value
    }
  }
478
  return result
}
481
/**
 * Properties defined for GraphQL types in Lattice can be defined as
 * a getter, a function or an async function. In the case of standard
 * functions, if they return a promise they will be handled as though
 * they were async. In addition to fetching the property, or field
 * resolver, its resulting function or getter will be invoked.
 *
 * Given the variety of things a GraphQL type can actually be, obtaining
 * its value can annoying. This method tends to lessen that boilerplate.
 * Errors raised will be thrown.
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀callProp
 *
 * @param {string} propName the name of the property in question
 * @param {Array&lt;mixed>} args the arguments array that will be passed
 * to `.apply()` should the property evaluate to a `function`
 * @return {mixed} the return value of any resulting function or
 * value returned by a getter; wrapped in a promise as all async
 * functions do.
 *
 * @throws {Error} errors raised in awaiting results will be thrown
 */
async callProp(propName: string, ...args: Array&lt;mixed>) {
  // $FlowFixMe
  let prop = this.getProp(propName, ...args);
  let result
510
  if (prop &amp;&amp; typeOf(prop) === 'AsyncFunction') {
    try {
      result = await prop.apply(this, args);
    }
    catch (error) {
      throw new AsyncFunctionExecutionError(error, prop, args, result)
    }
  }
  else if (prop &amp;&amp; typeOf(prop) === Function.name) {
    try {
      result = prop.apply(this, args)
    }
    catch (error) {
      throw new FunctionExecutionError(error, prop, args, result)
    }
526
    if (typeOf(result) === Promise.name) {
      try {
        result = await result
      }
      catch (error) {
        throw new AwaitingPromiseError(error).setPromise(result)
      }
    }
  }
536
  return result
}
539
/**
 * A pass-thru method to the static function of the same name. The
 * difference being that if `requestData` is not specified, the
 * `requestData` object from this instance will be used to build the
 * resolvers in question.
 *
 * @instance
 * @method ⌾⠀getResolver
 * @memberof GQLBase
 *
 * @param {string} resolverName the name of the resolver as a string
 * @param {Object} requestData the requestData used to build the
 * resolver methods from which to choose
 * @return {Function} returns either a `function` representing the
 * resolver requested or null if there wasn't one to be found
 */
async getResolver(resolverName: string, requestData: Object) {
  return await this.constructor.getResolver(
    resolverName,
    requestData || this.requestData
  )
}
562
/**
 * Resolvers are created in a number of different ways. OOP design
 * dictates that instances of a created class will handle field
 * resolvers, but query, mutation and subscription resolvers are
 * typically what creates these instances.
 *
 * Since a resolver can be created using `@mutator/@subscriptor/@resolver`
 * or via method on a object returned from `RESOLVERS()`, `MUTATORS()` or
 * `SUBSCRIPTIONS()`, there should be an easy to use way to fetch a
 * resolver by name; if for nothing else, code reuse.
 *
 * Pass the name of the resolver to the function and optionally pass a
 * requestData object. The `getMergedRoot()` method will build an object
 * containing all the root resolvers for the type, bound to the supplied
 * `requestData` object. It is from this object that `resolverName` will
 * be used to fetch the function in question. If one exists, it will be
 * returned, ready for use. Otherwise, null will be your answer.
 *
 *
 * @static
 * @method ⌾⠀getResolver
 * @memberof GQLBase
 *
 * @param {string} resolverName the name of the resolver as a string
 * @param {Object} requestData the requestData used to build the
 * resolver methods from which to choose
 * @return {Function} returns either a `function` representing the
 * resolver requested or null if there wasn't one to be found
 */
static async getResolver(resolverName: string, requestData: Object) {
  const reqData = requestData || null
  const rootObj = await this.getMergedRoot(reqData)
595
  return rootObj[resolverName] || null
}
598
/**
 * The static version of getProp reads into the prototype to find the field
 * that is desired. If the field is either a getter or a initializer (see
 * class properties descriptors), then the option to bind that to either the
 * prototype object or one of your choosing is available.
 *
 * @memberof GQLBase
 * @method ⌾⠀getProp
 * @static
 *
 * @param {string|Symbol} propName a string or Symbol denoting the name of
 * the property or field you desire
 * @param {boolean} bindGetters true if a resulting `getter` or `initializer`
 * should be bound to the prototype or other object
 * @param {mixed} bindTo the object to which to bind the `getter` or
 * `initializer` functions to if other than the class prototype.
 * @return {mixed} a `Function` or other mixed value making up the property
 * name requested
 */
static getProp(
  propName: string,
  bindGetters: boolean = false,
  bindTo: mixed
) {
  let descriptor = Object.getOwnPropertyDescriptor(this.prototype, propName)
624
  if (descriptor) {
    if (descriptor.get || descriptor.initializer) {
      let what = descriptor.initializer || descriptor.get
628
      if (bindGetters) {
        bindTo = bindTo || this.prototype
631
        return what.bind(bindTo)
      }
      else {
        return what
      }
    }
    else {
      return descriptor.value
    }
  }
  else {
    return null
  }
}
646
/**
 * Until such time as the reference implementation of Facebook's GraphQL
 * SDL AST parser supports comments, or until we take advantage of Apollo's
 * AST parser, this is how comments will be applied to a built schema.
 *
 * Several constants are defined on the GQLBase object itself, and thereby
 * all its subclasses. They pertain to how to define description fields
 * for various parts of your GQL implementation.
 *
 * ```
 * // To define a description on the top level class
 * [this.DOC_CLASS]: string
 *
 * // To define a description on a field (getter, function or async function)
 * [this.DOC_FIELDS]: {
 *   fieldName: string
 * }
 *
 * // To define a description on a query, mutation or subscription field
 * [this.DOC_QUERIES || this.DOC_MUTATORS || this.DOC_SUBSCRIPTIONS]: {
 *   fieldName: string
 * }
 * ```
 *
 * To make writing code easier, the `joinLines()` template function is
 * available so your source code can look nice and neat and your descriptions
 * won't get annoying line breaks and spaces as part of that process.
 *
 * @static
 * @memberof GQLBase
 * @method apiDocs
 *
 * @return {Object} an object with various keys and values denoting
 * description fields that should be applied to the final schema object
 */
static apiDocs(): Object {
  return {
    [this.DOC_CLASS]: joinLines`
      GQLBase class implementation. GQLBase is the root class used in
      graphql-lattice to describe a GraphQLObjectType. If you are reading
      this, the person using lattice failed to provide documentation for
      their type. :)
    `,
690
    [this.DOC_QUERY]: joinLines`
      ## Welcome to GraphQL Lattice
      **Query**
694
      You will want to define a \`DOC_QUERY\` apiDoc comment with something
      more meaningful to your particular Schema here.
    `,
698
    [this.DOC_MUTATION]: joinLines`
      ## Welcome to GraphQL Lattice
      **Mutation**
702
      You will want to define a \`DOC_MUTATION\` apiDoc comment with
      something more meaningful to your particular Schema here.
    `,
706
    [this.DOC_SUBSCRIPTION]: joinLines`
      ## Welcome to GraphQL Lattice
      **Subscription**
710
      You will want to define a \`DOC_SUBSCRIPTION\` apiDoc comment with
      something more meaningful to your particular Schema here.
    `,
714
    [this.DOC_FIELDS]: {
      // fieldName: `fieldDescription`,
    },
718
    [this.DOC_QUERIES]: {
      // queryName: `queryDescription`,
    },
722
    [this.DOC_MUTATORS]: {
      // mutatorName: `mutatorDescription`
    },
726
    [this.DOC_SUBSCRIPTIONS]: {
      // subscriptionName: `subscriptionDescription`
    }
  }
}
732
/**
 * Defined in a base class, this getter should return either a String
 * detailing the full IDL schema of a GraphQL handler or one of two
 * types of Symbols.
 *
 * The first Symbol type is the constant `ADJACENT_FILE`. If this Symbol is
 * returned, the system assumes that next to the source file in question is
 * a file of the same name with a .graphql extension. This file should be
 * made of the GraphQL IDL schema definitions for the object types being
 * created.
 *
 * Example:
 * ```js
 *   static get SCHEMA(): string | Symbol {
 *     return GQLBase.ADJACENT_FILE
 *   }
 * ```
 *
 * The primary advantage of this approach is allowing an outside editor that
 * provides syntax highlighting rather than returning a string from the
 * SCHEMA getter.
 *
 * Alternatively, the static method IDLFilePath can be used to point to an
 * alternate location where the GraphQL IDL file resides. The extension can
 * also be changed from .graphql to something else if need be using this
 * method.
 *
 * Example:
 * ```js
 *   static get SCHEMA(): string | Symbol {
 *     return GQLBase.IDLFilePath('/path/to/file', '.idl')
 *   }
 * ```
 *
 * @instance
 * @memberof GQLBase
 * @method ⬇︎⠀SCHEMA
 * @readonly
 * @static
 *
 * @return {string|Symbol} a valid IDL string or one of the Symbols
 * described above.
 *
 * @see {@link GQLBase#ADJACENT_FILE}
 * @see {@link GQLBase#IDLFilePath}
 */
static get SCHEMA(): string | Symbol {
  return ''
}
782
/**
 * This method should return a promise that resolves to an object of
 * functions matching the names of the mutation operations. These are to be
 * injected into the root object when used by `GQLExpressMiddleware`.
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀MUTATORS
 * @readonly
 * @static
 *
 * @param {Object} requestData typically an object containing three
 * properties; {req, res, gql}
 * @return {Promise} a promise that resolves to an object; see above for more
 * information.
 */
static async MUTATORS(requestData: Object): Promise&lt;Object> {
  // define in base class
  return {};
}
803
/**
 * This method should return a promise that resolves to an object of
 * functions matching the names of the query operations. These are to be
 * injected into the root object when used by `GQLExpressMiddleware`.
 *
 * @instance
 * @memberof GQLBase
 * @method ⌾⠀RESOLVERS
 * @readonly
 * @static
 *
 * @param {Object} requestData typically an object containing three
 * properties; {req, res, gql}
 * @return {Promise} a promise that resolves to an object; see above for more
 * information.
 */
static async RESOLVERS(requestData: Object): Promise&lt;Object> {
  // define in base class
  return {};
}
824
/**
 * @see {@link GQLBase#SCHEMA}
 *
 * @memberof GQLBase
 * @method ⬇︎⠀ADJACENT_FILE
 * @static
 * @const
 *
 * @return {Symbol} the Symbol, when returned from SCHEMA, causes
 * the logic to load an IDL Schema from an associated file with a .graphql
 * extension and bearing the same name.
 */
static get ADJACENT_FILE(): Symbol {
  return Symbol.for('.graphql file located adjacent to source')
}
840
/**
 * Determines the default type targeted by this GQLBase class. Any
 * type will technically be valid but only will trigger special behavior
 *
 * @memberof GQLBase
 * @method ⬇︎⠀GQL_TYPE
 * @static
 * @const
 *
 * @return {Function} a type, such as `GraphQLObjectType` or
 * `GraphQLInterfaceType`
 */
static get GQL_TYPE(): Function {
  return GraphQLObjectType;
}
856
/**
 * Creates an appropriate Symbol crafted with the right data for use by
 * the IDLFileHandler class below.
 *
 * @static
 * @memberof GQLBase
 * @method ⌾⠀IDLFilePath
 *
 * @param {string} path a path to the IDL containing file
 * @param {string} [extension='.graphql'] an extension, including the
 * prefixed period, that will be added to the supplied path should it not
 * already exist.
 * @return Symbol
 *
 * @see {@link GQLBase#SCHEMA}
 */
static IDLFilePath(path: string, extension: string = '.graphql'): Symbol {
  return Symbol.for(`Path ${path} Extension ${extension}`);
}
876
/**
 * A file handler for fetching the IDL schema string from the file system
 * for those `GQLBase` extended classes that have indicated to do so by
 * returning a `Symbol` for their `SCHEMA` property.
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀handler
 *
 * @return {IDLFileHandler} instance of IDLFileHandler, created if one does
 * not already exist, for fetching the contents from disk.
 */
static get handler(): IDLFileHandler {
  const key = Symbol.for(`${IDLFileHandler.name}.${this.name}`);
891
  // @ComputedType
  if (!this[key]) {
    // @ComputedType
    this[key] = new IDLFileHandler(this);
  }
897
  // @ComputedType
  return this[key];
}
901
/**
 * Returns the module object where your class is created. This needs to be
 * defined on your class, as a static getter, in the FILE where you are
 * defining your Class definition.
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀module
 * @const
 *
 * @return {Object} the reference to the module object defined and injected
 * by node.js' module loading system.
 *
 * @see https://nodejs.org/api/modules.html
 */
static get module(): Object {
  return module;
}
920
/**
 * The internal data model has some custom `EventEmitter` code wrapped
 * it here. When the data model is set via `setModel` or by accessing it
 * via `instance[MODEL_KEY]`, an event `EVENT_MODEL_SET` is emitted. Any
 * listener listening for this event receives an object with two keys
 * ```
 * {
 *   model: The actual model being set; changes are persisted
 *   instance: The GQLBase instance the model is associated with
 * }
 * ```
 *
 * Subsequently, the events `EVENT_MODEL_PROP_CHANGE` and
 * `EVENT_MODEL_PROP_DELETE` can be listened to if your version of node
 * supports Proxy objects. They allow you to be notified whenever your
 * model has a property changed or deleted, respectively.
 *
 * The callback for `change` receives an object with four properties
 * ```
 * {
 *   model: The model object the value is being changed on
 *   old: The old value being replaced; undefined if it is the first time
 *   key: The property key for the value being changed
 *   value: The new value being set
 * }
 * ```
 *
 * The callback for `delete` receives an object with four properties
 * ```
 * {
 *   model: The model object the value is deleted from
 *   key: The property key for the deleted value
 *   deleted: The deleted value
 * }
 * ```
 *
 * @static
 * @memberof GQLBase
 * @method ⌾⠀setupModel
 *
 * @param {GQLBase} instance typically `this` as passed in from a call in
 * the constructor
 */
static setupModel(instance: GQLBase) {
  const changeHandler: Object = {
    /**
     * Proxy set() handler. This is where the change events are fired from
     *
     * @method GQLBase~set
     * @param {Object} target the `GQLBase` model object
     * @param {string} key the property name
     * @param {mixed} value the new property value
     */
    set(target, key, value) {
      const old = target[key];
976
      target[key] = value;
      instance.emit(GQLBase.EVENT_MODEL_PROP_CHANGE, {
        model: target,
        old,
        key,
        value
      })
    },
985
    /**
     * Proxy deleteProperty() handler. This is where the delete property
     * events are fired from
     *
     * @method GQLBase~deleteProperty
     * @param {Object} target the `GQLBase` model object
     * @param {string} key the property name
     */
    deleteProperty(target, key) {
      const deleted = target[key];
996
      delete target[key];
      instance.emit(GQLBase.EVENT_MODEL_PROP_DELETE, {
        model: target,
        key,
        deleted
      })
    }
  }
1005
  /**
   * 'Publicly' the Symbol for accessing the `GQLBase` model is `MODEL_KEY`.
   * In truth it is stored under a Symbol defined in `setupModel` and
   * referred to as `_MODEL_KEY` in this code. This is done so a getter and
   * setter can be wrapped around the usage of the instance's data model.
   *
   * When being read, if `Proxy` exists in the node environment and if there
   * are any registered `EVENT_MODEL_PROP_CHANGE` or `EVENT_MODEL_PROP_DELETE`
   * events, then the returned model is a Proxy around the real model that
   * allows us to capture the changes and deletion of keys
   *
   * When being assigned, the event `EVENT_MODEL_WILL_BE_SET` and the event
   * `EVENT_MODEL_HAS_BEEN_SET` are emitted to allow listeners to modify and
   * see the final data around the setting of a model object. Both events
   * receive an object with two keys
   *
   * ```
   * {
   *   model: The object being or having been set
   *   instance: The GQLBase instance receiving the model
   * }
   * ```
   */
  Object.defineProperty(instance, MODEL_KEY, {
    get: function() {
      let model = this[_MODEL_KEY]
      let hasListeners =
        this.listenerCount(GQLBase.EVENT_MODEL_PROP_CHANGE) +
        this.listenerCount(GQLBase.EVENT_MODEL_PROP_DELETE)
1035
      if (hasProxy &amp;&amp; hasListeners) {
        model = new Proxy(model, changeHandler);
      }
1039
      return model
    },
1042
    set: function(model) {
      const instance = this;
1045
      this.emit(GQLBase.EVENT_MODEL_WILL_BE_SET, { model, instance });
      instance[_MODEL_KEY] = model;
      this.emit(GQLBase.EVENT_MODEL_HAS_BEEN_SET, { model, instance })
    }
  });
}
1052
/**
 * If ES6 Proxies are supported in your execution environment, all GQLBase
 * extended classes are also proxies. By default the internal proxy handler
 * provides backwards compatibility with the removal of the default getters
 * and setters for the 'model' property as long as you do not define a
 * top level 'model' property of your own.
 *
 * @method ⬇︎⠀[_PROXY_HANDLER]
 * @memberof GQLBase
 * @static
 * @const
 * @since 2.5.0
 *
 * @type {Object}
 * @ComputedType
 */
static get [_PROXY_HANDLER]() {
  return {
    get(target, key, lastResult) {
      const model = target[_MODEL_KEY];
1073
      // Allow backwards compatibility for 'model' property if one is not
      // explicitly defined on your instance.
      if (notDefined('model', key, target)) {
        // Be sure to use the public MODEL_KEY to ensure events fire
        return target[MODEL_KEY];
      }
1080
      return target[key]
    }
  }
}
1085
/**
 * 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 ModuleParser
 * @static
 *
 * @return {string} the name of this class
 * @ComputedType
 */
static get [Symbol.toStringTag]() { return this.name }
1099
/**
 * A constant used to register an event listener for when the internal
 * model object is assigned a new value. This event fires before the model
 * is set. Changes to the model value at this point will affect the contents
 * before the value assignment takes place.
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀EVENT_MODEL_WILL_BE_SET
 * @const
 *
 * @type {string}
 */
static get EVENT_MODEL_WILL_BE_SET() { return 'E: Int. model will be set' }
1114
/**
 * A constant used to register an event listener for when the internal
 * model object is assigned a new value. This event fires after the model
 * is set.
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀EVENT_MODEL_HAS_BEEN_SET
 * @const
 *
 * @type {string}
 */
static get EVENT_MODEL_HAS_BEEN_SET() { return 'E: Int. model has been set' }
1128
/**
 * A constant used to register an event listener for when a property of the
 * internal model object is set to a new or intial value.
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀EVENT_MODEL_PROP_CHANGE
 * @const
 *
 * @type {string}
 */
static get EVENT_MODEL_PROP_CHANGE() { return 'E: Int. model prop changed' }
1141
/**
 * A constant used to register an event listener for when a property of the
 * internal model object has been deleted. This event fires after the value
 * has been deleted.
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀EVENT_MODEL_PROP_DELETE
 * @const
 *
 * @type {string}
 */
static get EVENT_MODEL_PROP_DELETE() { return 'E: Int. model prop deleted' }
1155
/**
 * A constant key used to identify a comment for a class description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_CLASS
 * @const
 *
 * @type {string}
 */
static get DOC_CLASS() { return 'class' }
1167
/**
 * A constant key used to identify a comment for a type field description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_FIELDS
 * @const
 *
 * @type {string}
 */
static get DOC_FIELDS() { return 'fields' }
1179
/**
 * A constant key used to identify a comment for the top level query
 * description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_QUERY
 * @const
 *
 * @type {string}
 */
static get DOC_QUERY() { return 'query' }
1192
/**
 * A constant key used to identify a comment for a query description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_QUERIES
 * @const
 *
 * @type {string}
 */
static get DOC_QUERIES() { return 'queries' }
1204
/**
 * A constant key used to identify a comment for the top level mutation
 * description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_MUTATION
 * @const
 *
 * @type {string}
 */
static get DOC_MUTATION() { return 'mutation' }
1217
/**
 * A constant key used to identify a comment for a mutator description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_MUTATORS
 * @const
 * @deprecated Use `DOC_MUTATIONS` instead
 *
 * @type {string}
 */
static get DOC_MUTATORS() { return 'mutators' }
1230
/**
 * A constant key used to identify a comment for a mutator description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_MUTATORS
 * @const
 *
 * @type {string}
 */
static get DOC_MUTATIONS() { return 'mutators' }
1242
/**
 * A constant key used to identify a comment for the top level subscription
 * description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_SUBSCRIPTION
 * @const
 *
 * @type {string}
 */
static get DOC_SUBSCRIPTION() { return 'subscription' }
1255
/**
 * A constant key used to identify a comment for a subscription description
 *
 * @static
 * @memberof GQLBase
 * @method ⬇︎⠀DOC_SUBSCRIPTIONS
 * @const
 *
 * @type {string}
 */
static get DOC_SUBSCRIPTIONS() { return 'subscriptions' }
1267
/**
 * A shortcut to the utils/joinLines function to make it easier to get
 * the tools to write docs for your types in a friendly fashion.
 *
 * @memberof GQLBase
 * @method ⬇︎⠀joinLines
 * @static
 * @const
 *
 * @type {Function}
 */
static get joinLines(): Function { return joinLines }
1280
/**
 * An simple pass-thru method for fetching a types merged root object.
 *
 * @method ⌾⠀getMergedRoot
 * @memberof GQLBase
 * @static
 *
 * @param {Object} requestData an object containing the request data such as
 * request, response or graphql context info that should be passed along to
 * each of the resolver creators
 * @return {Object} the merged root object with all the query, mutation and
 * subscription resolvers defined and created within.
 */
static async getMergedRoot(
  requestData: Object,
  separateByType: boolean = false
): Object {
  const root = {};
  const Class = this;
1300
  let _ = {
    // $FlowFixMe
    resolvers: Class[META_KEY].resolvers || [],
    // $FlowFixMe
    mutators: Class[META_KEY].mutators || [],
    // $FlowFixMe
    subscriptors: Class[META_KEY].subscriptors || []
  }
1309
  let convert = f => {
    let isFactoryClass = (c) => {
      return !!Class[META_KEY][Symbol.for('Factory Class')]
    }
1314
    if (isFactoryClass(Class)) {
      return {
        [f.name]: function(...args) {
          return f.apply(Class, [Class, requestData, ...args])
        }
      }
    }
    else {
      return {
        [f.name]: function(...args) {
          return f.apply(Class, [requestData, ...args])
        }
      }
    }
  }
  let reduce = (p, c) => merge(p, c)
1331
  _.resolvers = _.resolvers.map(convert).reduce(reduce, {})
  _.mutators = _.mutators.map(convert).reduce(reduce, {})
  _.subscriptors = _.subscriptors.map(convert).reduce(reduce, {})
1335
  if (separateByType) {
    // Apollo wants all the resolvers to grouped by top level type.
    // The field resolvers aren't an issue in Lattice defined types
    // but the root types do need to be sorted; so let's do that here
    merge(
      root,
      { Query: await Class.RESOLVERS(requestData) },
      { Mutation: await Class.MUTATORS(requestData) },
      { Query: _.resolvers },
      { Mutation: _.mutators },
      { Subscription: _.subscriptors }
    );
1348
    // When using lattice with apollo server, it is quite particular about
    // empty Query, Mutation or Subscription resolver maps.
    if (!Object.keys(root.Query).length) delete root.Query
    if (!Object.keys(root.Mutation).length) delete root.Mutation
    if (!Object.keys(root.Subscription).length) delete root.Subscription
  }
  else {
    merge(
      root,
      await Class.RESOLVERS(requestData),
      await Class.MUTATORS(requestData),
      _.resolvers,
      _.mutators,
      _.subscriptors
    );
  }
1365
  return root;
}
1368
/**
 * An object used to store data used by decorators and other internal
 * proccesses.
 * @ComputedType
 */
static get [META_KEY]() {
  let storage = this[Symbol.for(this.name)]
1376
  if (!storage) {
    storage = (this[Symbol.for(this.name)] = {})
  }
1380
  return storage;
}
1383}
1384
1385export default GQLBase;
1386</code></pre>
      </article>
  </section>
1389
1390
1391
1392
1393</div>
1394
1395<br class="clear">
1396
1397<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.
1399</footer>
1400
1401<script>prettyPrint();</script>
1402<script src="scripts/linenumber.js"></script>
1403</body>
1404</html>