UNPKG

graphql-lattice/docs/LatticeFactory.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>LatticeFactory.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">LatticeFactory.js</h1>
  
34
  
36
37
38
  
  <section>
      <article>
          <pre class="prettyprint source linenums"><code>// @flow
43
44import { GQLBase, META_KEY } from './GQLBase'
45import { GQLEnum } from './GQLEnum'
46import { GQLInterface } from './GQLInterface'
47import { GQLScalar } from './GQLScalar'
48// import { GQLUnion } from './GQLUnion'
49import { SyntaxTree } from './SyntaxTree'
50import { customDedent } from 'ne-tag-fns'
51import { typeOf, extendsFrom } from 'ne-types'
52import { inspect } from 'util'
53import { resolver, mutator, subscriptor } from './decorators/Resolvers'
54import { Properties } from './decorators/ModelProperties'
55import { LatticeLogs as LL } from './utils'
56
57const _i = (...args) => inspect(...args, {colors: true, depth: 3})
58
59
60/**
* The CHECKLIST Symbol is used as a storage key in the metadata staging
* area for each of the GQLBase extended classes. In the LatticeFactory
* it is used to determine where in the flow of construction the class
* currently is.
*
* @type {Symbol}
*/
68export const CHECKLIST = Symbol.for('checklist')
69
70/**
* The CHECK_SCHEMA Symbol is part of the CHECKLIST for a constructed
* GQLBase extended class. It denotes that the class has had its SCHEMA
* getter defined.
*
* @type {Symbol}
*/
77export const CHECK_SCHEMA = Symbol.for('checklist-schema')
78
79/**
* The CHECK_RESOLVERS Symbol is part of the CHECKLIST for a constructed
* GQLBase extended class. It denotes that the class has had its instance
* field resolvers as well as its static Query, Mutation and Subscription
* resolvers injected and defined.
*
* @type {Symbol}
*/
87export const CHECK_RESOLVERS = Symbol.for('checklist-resolvers')
88
89/**
* The CHECK_API_DOCS Symbol is part of the CHECKLIST for a constructed
* GQLBase extended class. It denotes that the class has had its api docs
* defined, processed and setup on the class in a way that it will be
* picked up in the build lifecycle.
*
* @type {Symbol}
*/
97export const CHECK_API_DOCS = Symbol.for('checklist-api-docs')
98
99/**
* Peeks into the metadata storage area of a given GQLBase extended
* class and fetches the factory checklist if one exists.
*
* @param {Function} Class a reference to the GQLBase class to peek in
* @return {Object} an object setup with at least three booleans keyed by
* the constants CHECK_SCHEMA, CHECK_RESOLVERS, and CHECK_API_DOCS or null
* if none exists
*/
108export function getChecklist(Class: Function) {
return (Class &amp;&amp; Class[META_KEY] &amp;&amp; Class[META_KEY][CHECKLIST]) || null
110}
111
112/**
* Obtains the checklist from the supplied GQLBase extended class. If the
* class has a checklist, its checklist item is set to true or the boolean
* value specified.
*
* @param {Function} Class a reference to the GQLBase class to set
* @param {Symbol} item one of CHECK_SCHEMA, CHECK_RESOLVERS, or
* CHECK_API_DOCS
* @param {Boolean} value the value for the checklist item to set
*/
122export function setChecklist(
Class: Function,
item: Symbol,
value: boolean = true
126) {
let checklist = getChecklist(Class)
128
if (checklist) {
  // $FlowFixMe
  checklist[item] = value
}
133}
134
135/**
* This function, when invoked with only a class will return true if the
* Class has a defined checklist. If one ore more CHECKLIST symbols are
* passed, the function will only return true if all the supplied symbols
* are set to truthy values.
*
* @param {Function} Class a reference to the GQLBase class to set
* @param {Array&lt;Symbol>} items any of CHECK_SCHEMA, CHECK_RESOLVERS, or
* CHECK_API_DOCS
* @return {Boolean} true if the checklist and/or all items are true and
* present.
*/
147export function hasChecklist(Class: Function, ...items: Array&lt;Symbol>) {
let checklist = getChecklist(Class)
149
if (checklist &amp;&amp; items.length) {
  for (let item of items) {
    if (!checklist[item]) {
      return false
    }
  }
156
  return true
}
159
return checklist
161}
162
163/**
* Injects and creates a new CHECKLIST object on the supplied GQLBase
* extended class. All items are installed and set to false.
*
* @param {Function} Class a reference to the GQLBase class to set
*/
169export function newChecklist(Class: Function) {
if (Class) {
  // $FlowFixMe
  Class[META_KEY][CHECKLIST] = {
    [CHECK_SCHEMA]: false,
    [CHECK_RESOLVERS]: false,
    [CHECK_API_DOCS]: false,
176
    get keys() {
      return [
        CHECK_SCHEMA, CHECK_RESOLVERS, CHECK_API_DOCS
      ]
    },
182
    get complete() {
      return this.keys.reduce((p,c,i,a) => {
        if (!p || !this[c]) { return false }
      }, true)
    }
  }
}
else {
  throw new Error(customDedent({dropLowest:true})`
    Cannot create new checklist metadata on a non-existent class
  `)
}
195}
196
197export class ValidationResults {
errors: Array&lt;Error>
199
constructor(errors: Array&lt;Error> = []) {
  this.errors = errors
}
203
get valid(): boolean { return this.errors.length === 0 }
205
// $FlowFixMe
get [Symbol.toStringTag](): string { return this.constructor.name }
208
// $FlowFixMe
static get [Symbol.toStringTag](): string { return this.name }
211}
212
213export class LatticeFactory {
214
/**
 * Walks through a supplied template object and collects errors with its
 * format before bubbling up an exception if any part of it fails to
 * pass muster. The exception can be prevented from throwing if hide is set
 * to true
 *
 * @param {Object} template an object to be parsed for construction via the
 * Lattice Factory
 * @param {boolean} hide if true, an invalid template will NOT throw errors
 * @return {ValidationResults} a `ValidationResults` object containing the
 * collected errors and a `valid` that is dynamically calculated.
 */
static validateTemplate(
  template: Object,
  hide: boolean = false
): ValidationResults {
  let results = new ValidationResults()
  let indent = (string: string, count: number = 4, space: string = ' ') => (
    string
      .split('\n')
      .map(s => s.trim().replace(/(^)/gm, `$1${space.repeat(count)}`))
      .join('\n')
  )
238
  if (typeof template.name === 'undefined') {
    results.errors.push(new Error(customDedent({dropLowest:true})`
      The \`template.name\` field must exist or the creation for the Lattice
      factory class generation to succeed.
243
      Please read the documentation for more information on the format of
      a LatticeFactory template.
    `))
  }
248
  if (!extendsFrom(template.name, String)) {
    results.errors.push(new Error(customDedent({dropLowest:true})`
      The \`template.name\` field must be a string.
252
      Please read the documentation for more information on the format of
      a LatticeFactory template.
    `))
  }
257
  if (typeof template.schema === 'undefined') {
    results.errors.push(new Error(customDedent({dropLowest:true})`
      The \`template.schema\` field must exist or the creation for the
      Lattice factory class generation to succeed.
262
      Please read the documentation for more information on the format of
      a LatticeFactory template.
    `))
  }
267
  if (!extendsFrom(template.schema, String)) {
    results.errors.push(new Error(customDedent({dropLowest:true})`
      The \`template.schema\` field must be a string of GraphQL SDL/IDL
271
      Please read the documentation for more information on the format of
      a LatticeFactory template.
    `))
  }
276
  if (
    !extendsFrom(template.resolvers, Object)  // Supports 95% of objects
    || typeof template.resolvers !== 'object' // Supports Object.create(null)
  ) {
    results.errors.push(new Error(customDedent({dropLowest:true})`\x1b[91;1m
      The \`template.resolvers\` field must be an Object containing the
      resolver functions. Query, Mutation and Subscription resolvers will
      take the following signature. Additionally, the keys for these special
      resolvers must be Query, Mutation or Subscription; respectively
      \x1b[37;22m
        Query: { [resolver]: (requestData, resolverParameters) => {} }
        Mutation: { [resolver]: (requestData, resolverParameters) => {} }
        Subscription: { [resolver]: (requestData, resolverParameters) => {} }
290
        where:
          \`requestData\` is an object with { req, res, gql|next } depending
            on the graphql server implementation (FB Reference, Apollo, etc)
          \`resovlerParameters\` is an object with keys matching those
            parameters defined in the SCHEMA for the resolver in question.
      \x1b[91;1m
      Field resolvers should be found under the key name of the type
      or interface in question and must correspond to the following signature
      \x1b[37;22m
        [Type]: { [resolver]: (resolverParameters) => {} }
301
        where:
          \`Type\` is the name of the GQL type defined in the schema
          \`resovlerParameters\` is an object with keys matching those
            parameters defined in the SCHEMA for the resolver in question.
306
        * it is worth noting that the field resolvers are not static and
          can access the \`requestData\` object via \`this.requestData\`
      \x1b[91;1m
      Please read the documentation for more information on the format of
      a LatticeFactory template.\x1b[0m
    `))
  }
314
  if (typeof template.docs === 'undefined') {
    results.errors.push(new Error(customDedent({dropLowest:true})`
      The \`template.docs\` field must exist for the creation of the
      Lattice factory class generation to succeed.
319
      Please read the documentation for more information on the format of
      a LatticeFactory template.
    `))
  }
324
  if (
    !extendsFrom(template.docs, Object)  // Supports 95% of objects
    || typeof template.docs !== 'object' // Supports Object.create(null)
  ) {
    let dr = '\x1b[31m', br = '\x1b[91m'
    let b1 = '\x1b[1m', b0 = '\x1b[22m'
    let bb = '\x1b[90m'
    let dg = '\x1b[37m', bg = '\x1b[97m'
    let a0 = '\x1b[0m'
    let gr = '\x1b[32m', bgr = '\x1b[92m'
335
    results.errors.push(new Error(customDedent({dropLowest:true})`\x1b[1;91m
      The \`template.docs\` field must be an object containing keys and
      value pairs matching the types, enums, unions and interfaces defined
      in your schema.
340
      The special Symbol object TYPE can be used to reference the docs for
      the named or keyed field describing the documentation to be processed
      Comments for the \`Query\`, \`Mutation\`, and \`Subscription\` [TYPE]
      entries will replace any previous one that comes before it. Typically
      this field is best left undescribed since there will ever only be
      one of each at most.
347
      \x1b[22;31mExamples should look something like this:\x1b[22;37m
        import { TYPE, joinLines } from 'graphql-lattice'
350
        export default {
          ${bb}/* other fields */${dg}
353
          ${b1}schema:${b0} joinLines${gr}\`
            type Person { id: ID name: String }
            type Query { findPerson(id: ID): Person }
            type Mutation { setPersonName(id: ID, name: String): Person }
          \`${dg},
359
          ${b1}docs:${b0} {
            ${b1}Person:${b0} {
              [TYPE]: ${gr}'A contrived person type'${dg},
              id: ${gr}'A unique identifier for a person'${dg},
              name: ${gr}'A string denoting the name of a person'${dg}
            },
            ${b1}Query:${b0} {
              findPerson: ${gr}'A query taking an ID, returns a Person'${dg},
            },
            ${b1}Mutation:${b0} {
              setPersonName: joinLines${gr}\`
                A mutation that sets the name of the user identified by an
                ID to the new name value supplied
              \`${dg}
            }
          }
        }
      \x1b[22;31m
      Note the usage of \`Person\`, \`Query\` and \`Mutation\` explicitly
      as keys to the supplied \`docs\` object.\x1b[0m
    `))
  }
382
  if (!results.valid) {
    let errorStrings = []
385
    for (let error of results.errors) {
      let { message, stack } = error
388
      stack = stack
        .trim()
        .split('\n')
        .splice(message.split('\n').length)
        .map(s => s.trim())
        .join('\n')
      message = message.replace(/(Error:\s)/, '$1\n').trim()
396
      errorStrings.push(
        `\x1b[31;1m${message}\x1b[0m\n` + indent(stack)
      )
    }
401
    let error = new Error(customDedent({dropLowest:true})`
      OOPS!
404
      An error occurred validating your factory template. The object
      in question is as follows:
407
      @template
409
      The individual errors that occurred are:
      \n@errors`
      .replace(/@template/, indent(_i(template)))
      .replace(/@errors/, errorStrings.join('\n\n'))
    )
415
    error.stack = error.message
    error.message = ''
418
    if (!hide) throw error
  }
421
  return results
}
424
/**
 * The starting point of a LatticeFactory object -> class creation. The name
 * of the class and baseClass to use are provided and are created from there.
 * At this point, the generated class is still incomplete. It must complete
 * the entire checklist before being deemed valid.
 *
 * @param {string} name name of the class to create
 * @param {Function} baseClass the Lattice class your new class should extend;
 * while this can be anything, it should be GQLBase, GQLInterface, GQLEnum or
 * GQLUnion. This defaults to GQLBase should nothing be supplied
 * @return {Function} actually this returns the generated class
 */
static generateClass(name: string, baseClass: Function = GQLBase) {
  if (!name) {
    throw new Error('LatticeFactory.generateClass needs a name!!')
  }
441
  // Alright ladies and gentlemen, hold onto your hats; we're entering the
  // meta zone!!! The way the following works is to make sure that our
  // passed in base class `baseClass` is actually in scope as the name of
  // the value it represents. We use the `new Function()` syntax to do that
  // but we do it via eval since we don't know the name of the function
  // at the time we write the code
  //
  // So given a class name of "Car" and baseName equalling GQLBase, the Class
  // instance, fn would look something like the results of calling this
  //
  // let fn = new Function(
  //   "GQLBase",
  //   "class Car extends GQLBase {}; return Car;"
  // )
  //
  // Which in turn sets fn to something that would be the same as
  //
  // function fn(GQLBase) { class Car extends GQLBase {}; return Car }
  //
  // Which means that when we invoke fn(baseClass), which is fn(GQLBase),
  // we get the results we intend; even if GQLBase is not necessarily in
  // the scope of the function at the time of call. Neat. Scary. OMG Thanks
  // for code comments. You're welcome future me.
  let fn = eval(`(new Function(
    "${baseClass.name}",
    "class ${name} extends ${baseClass.name} {}; return ${name};"
  ))`);
469
  let Class = fn(baseClass)
471
  this.brandClass(Class)
  newChecklist(Class)
474
  return Class;
}
477
/**
 * Injects the SCHEMA property into the newly defined class. The supplied
 * `schema` string becomes what the new class returns when `.SCHEMA` is
 * gotten.
 *
 * @param {Function} Class this will throw an error if the class is not one
 * generated by the LatticeFactory or if the class itself is null or undefined
 * @param {string} schema the string that the new class should return
 * @return {Function} returns the modified Class with the `CHECK_SCHEMA`
 * portion ticked off internally.
 */
static injectSchema(Class: Function, schema: string) {
  if (!Class || !hasChecklist(Class)) {
    throw new Error(customDedent({dropLowest:true})`
      Either the supplied schema string is invalid
        SCHEMA: \`
          ${schema}
        \`
496
      Or your supplied class ${(Class &amp;&amp; Class.name) || 'undefined'} is
      non-existent. Please check your code and try the LatticeFactory
      again.
    `)
  }
502
  // $FlowFixMe
  Object.defineProperty(Class, 'SCHEMA', {
    get() { return schema }
  })
507
  setChecklist(Class, CHECK_SCHEMA)
509
  return Class
}
512
/**
 * Injects the resolvers into appropriate areas. Resolvers keyed by `Query`,
 * `Mutation`, or `Subscription` will be placed into the appropriate area
 * in `Class[META_KEY]` which acts as a staging area originally designed for
 * use with the @resolver, @mutator and @subscriptor decorators. These will
 * be bound in a typical fashion as is done with the decorators making the
 * first parameter becoming the requestData of the object instance and the
 * second being the object containing the parameters for the resolver as
 * passed in by GraphQL. Subsequent parameters will be supplied as is the
 * fashion of the system you're using; Facebook's reference implementation or
 * Apollo or something else.
 *
 * Resolvers keyed by type name are considered to be field resolvers and
 * have a different signature. They can be properties of the key, in
 * which case they will simply be installed as getters. Or they can be
 * functions; synchronous or asynchronous. Function field resolvers are
 * instance methods and can make use of `this.getModel()` or
 * `this.requestData` internally.
 *
 * @param {Function} Class the class, generated by generateClass() lest an
 * error be thrown, to which to add the resolvers from a template
 * @param {Object} resolverObj an object containing the resolvers as dictated
 * by the new format.
 * @return {Function} returns the modified Class with the `CHECK_RESOLVERS`
 * portion ticked off internally.
 */
static injectResolvers(Class: Function, resolvers: Object): Function {
  if (!hasChecklist(Class, CHECK_SCHEMA)) {
    throw new Error(customDedent({dropLowest:true})`
      \`injectResolvers\` cannot be called on a class without a SCHEMA.
      Please verify your progress in the process and try again.
    `)
  }
546
  let tree = SyntaxTree.from(Class.SCHEMA)
  let outline = tree ? tree.outline : {}
549
  if (Class.name in outline &amp;&amp; Class.name in resolvers) {
    let fields = Object.keys(outline[Class.name])
552
    for (let fieldResolver of fields) {
      if (!fieldResolver in resolvers[Class.name]) {
        LL.warn(customDedent({dropLowest: true})`
          ${fieldResolver} not supplied in resolvers for ${Class.name}
        `)
        continue;
      }
560
      let prop = resolvers[Class.name][fieldResolver]
562
      if (prop &amp;&amp; typeof prop === 'function') {
        LL.info('Injecting [fn] %s', fieldResolver)
        Object.defineProperty(Class.prototype, fieldResolver, {
          value: prop
        })
      }
      else {
        LL.info('Injecting [prop] %s', fieldResolver)
        Properties(fieldResolver)(Class, ['factory-props'])
      }
    }
  }
575
  for (let [type: string, decorator: Function] of [
    ['Query', resolver],
    ['Mutation', mutator],
    ['Subscription', subscriptor]
  ]) {
    let keys = Object.keys(outline[type] || {})
582
    // $FlowFixMe
    if (!type in outline || !keys.length) { continue; }
585
    for (let fnName of keys) {
      let fn = resolvers[fnName]
      decorator(Class, fnName, {value: fn})
      LL.info('Adding %s resolver [%s]', type, fnName)
    }
  }
592
  setChecklist(Class, CHECK_RESOLVERS)
594
  return Class
}
597
static injectDocs(Class: Function, docs: Object): Function {
  if (!hasChecklist(Class, CHECK_SCHEMA, CHECK_RESOLVERS)) {
    throw new Error(customDedent({dropLowest:true})`
      \`injectDocs\` cannot be called on a class without a SCHEMA or
      RESOLVERS defined. Please verify your progress in the process and try
      again.
    `)
  }
606
  let copyProp = (
    o: mixed,
    prop: string | Symbol,
    to: mixed,
    as: ?(string | Symbol)
  ): mixed => {
    // $FlowFixMe
    let prototype = o.prototype || Object.getPrototypeOf(o)
    let descriptor = Object.getOwnPropertyDescriptor(prototype, prop)
616
    if (!as) {
      as = prop
    }
620
    if (descriptor) {
      Object.defineProperty(to, as, descriptor)
    }
    else {
      // $FlowFixMe
      to[as] = o[prop]
    }
  }
629
  // Create an object our future `static apiDocs()` method of our factory
  // generated class will return
  let result = {}
633
  // Setup the constants we will need in this conversion
  const { TYPE } = this;
  const {
    DOC_CLASS, DOC_FIELDS, DOC_QUERY, DOC_MUTATION, DOC_SUBSCRIPTION,
    DOC_QUERIES, DOC_MUTATIONS, DOC_SUBSCRIPTIONS
  } = GQLBase
640
  // This part might get a little meta, so I have provided comments. You are
  // welcome future me. I hope it helps. This gnarly block should cover all
  // the descriptions for Query, Mutation, Subscription and the Class we
  // are creating. Other superfluous
  for (let [Type, TopLevelConstant, FieldConstants] of [
    ['Query', DOC_QUERY, DOC_QUERIES],
    ['Mutation', DOC_MUTATION, DOC_MUTATIONS],
    ['Subscription', DOC_SUBSCRIPTION, DOC_SUBSCRIPTIONS],
    [Class.name, DOC_CLASS, DOC_FIELDS]
  ]) {
    // One of 'Query', 'Mutation', or 'Subscription'
    if (docs[Type]) {
      // If a top level description is present (i.e. Query, Mutation or
      // Subscription description)
      if (docs[Type][TYPE]) {
        copyProp(docs[Type], TYPE, result, TopLevelConstant)
      }
658
      // Fetch the properties from the supplied docs object; TYPE Symbols
      // do not show up in a call to entries which is why it is handled above
      // $FlowFixMe
      let entries = Object.entries(docs[Type])
663
      // If we have entries to document, create an object to hold those
      // values; i.e. if we have `{ Query: { getPeople: 'desc' } }`, we need
      // to make sure we have `{ [DOC_QUERIES]: { getPeople: 'desc' } }` in
      // our result. The object holding getPeople in the end there is defined
      // below when we have something to copy.
      if (entries.length) {
        result[FieldConstants] = {}
      }
672
      // For each name value pair defined above, copy its descriptor or base
      // value if a descriptor isn't available
      for (let [prop, value] of entries) {
        copyProp(docs[Type], prop, result[FieldConstants])
      }
    }
  }
680
  Object.defineProperty(Class, 'apiDocs', {
    value: function() { return result }
  })
684
  setChecklist(Class, CHECK_API_DOCS)
686
  return Class
}
689
static build(template: Object): Function {
  let validationResults = this.validateTemplate(template)
  let Class = this.generateClass(template.name, template.type || GQLBase)
693
  if (!Class) {
    throw new Error(customDedent({dropLowest: true})`
      LatticeFactory was unable to build your Class from the name and types
      supplied in your template. You provided the following template. Please
      look it over and correct any errors before trying again.
699
      \x1b[1mTemplate\x1b[0m
        ${_i(template)}
    `)
  }
704
  this.injectSchema(Class, template.schema)
  this.injectResolvers(Class, template.resolvers || {})
  this.injectDocs(Class, template.docs || {})
708
  // Need to fix how auto-props work; for now create one instance...
  new Class({})
711
  if (!hasChecklist(Class, CHECK_SCHEMA, CHECK_RESOLVERS, CHECK_API_DOCS)) {
    let _schema = hasChecklist(Class, CHECK_SCHEMA) ? '✅' : '❌'
    let _resolvers = hasChecklist(Class, CHECK_RESOLVERS) ? '✅' : '❌'
    let _apiDocs = hasChecklist(Class, CHECK_API_DOCS) ? '✅' : '❌'
716
    throw new Error(customDedent({dropLowest: true})`
      Something went wrong in the process of building the class called
      ${Class &amp;&amp; Class.name || template &amp;&amp; template.name || 'Unknown!'},
      please check the supplied template for errors.
721
      [ ${_schema} ] Has a SCHEMA defined
      [ ${_resolvers} ] Has defined RESOLVERS matching the SCHEMA
      [ ${_apiDocs} ] Has defined API Docs matching the SCHEMA
725
      \x1b[1mTemplate\x1b[0m
      ${_i(template)}
728
      \x1b[1mClass\x1b[0m
      ${_i(Class)}
    `)
  }
733
  return Class
}
736
/**
 * A static helper method to consistently tag, or brand, classes with a
 * symbol that denotes they were created using the LatticeFactory process.
 * This is done by setting a `Symbol` on the root of the class or in the
 * `[META_KEY]` object for classes extending `GQLBase`.
 *
 * @method ⌾⠀brandClass
 * @memberof LatticeFactory
 * @static
 *
 * @param {Function} Class the class to brand with the `FACTORY_CLASS` symbol
 * @return {Function} returns the Class value passed in
 */
static brandClass(Class: ?Function): ?Function {
  if (Class) {
    if (extendsFrom(Class, GQLBase)) {
      Class[META_KEY][this.FACTORY_CLASS] = true
    }
    else {
      Class[this.FACTORY_CLASS] = true
    }
  }
759
  return Class
}
762
/**
 * A static helper to check and see if the supplied class or function was
 * branded with the `brandClass()` function. This amounts to storing the
 * boolean true under the property `Class[LatticeFactory.FACTORY_CLASS]` or
 * `Class[META_KEY][LatticeFacatory.FACTORY_CLASS]` for `GQLBase` extended
 * classes.
 *
 * @method ⌾⠀isFactoryClass
 * @memberof LatticeFactory
 * @static
 *
 * @param {Function} Class the class to check for `FACTORY_CLASS` branding
 * @return {boolean} true if the brand exists, false otherwise
 */
static isFactoryClass(Class: Function): boolean {
  if (Class) {
    return (extendsFrom(Class, GQLBase)
      ? !!Class[META_KEY][this.FACTORY_CLASS]
      : !!Class[this.FACTORY_CLASS]
    )
  }
784
  return false
}
787
/**
 * A static helper method to consistently remove any previous tag or brand
 * applied with `brandClass`, this is done by removing a previously set
 * `Symbol` on the root of the class or in the `[META_KEY]` object for
 * classes extending `GQLBase`.
 *
 * @method ⌾⠀removeClassBrand
 * @memberof LatticeFactory
 * @static
 *
 * @param {Function} Class the class to brand with the `FACTORY_CLASS` symbol
 * @return {Function} returns the Class value passed in
 */
static removeClassBrand(Class: Function): Function {
  if (Class) {
    if (extendsFrom(Class, GQLBase)) {
      delete Class[META_KEY][this.FACTORY_CLASS]
    }
    else {
      delete Class[this.FACTORY_CLASS]
    }
  }
810
  return Class
}
813
/**
 * A constant that reports that this class is `'[object LatticeFactory]'`
 * rather than `'[object Object]'` when introspected with tools such as
 * `Object.prototype.toString.apply(class)`.
 *
 * @memberof LatticeFactory
 * @type {Symbol}
 * @static
 */
// $FlowFixMe
static get [Symbol.toStringTag]() { return this.name }
825
/**
 * A constant exported as part of LatticeFactory that can be used for
 * defining documentation for the type itself.
 *
 * @memberof LatticeFactory
 * @type {Symbol}
 * @static
 */
static get TYPE(): Symbol { return Symbol.for('API Docs Type Constant') }
835
/**
 * A constant exported as part of LatticeFactory that can be used for
 * identifying classes that were generated with LatticeFactory.
 *
 * @memberof LatticeFactory
 * @type {Symbol}
 * @static
 */
static get FACTORY_CLASS(): Symbol { return Symbol.for('Factory Class') }
845}
846
847export const isFactoryClass = LatticeFactory.isFactoryClass
848
849// TESTING REPL
850/**
851var { LatticeFactory, getChecklist, hasChecklist, CHECKLIST, CHECK_SCHEMA, CHECK_RESOLVERS } = require('./dist/LatticeFactory'); var { GQLBase, META_KEY, joinLines, SyntaxTree, typeOf } = require('./dist/lattice'); var gql = joinLines, LF = LatticeFactory, TYPE = LF.TYPE;
852var PersonDef = { name: 'Person', schema: gql` enum StatType { PHYSICAL, MENTAL } type Person { name: String stats(type:StatType): Stat } type Query { findPerson(id: ID): Person } `, resolvers: { Query: { findPerson({req, res, next}, {id}) { console.log('find person') } }, Person: { stats({type}) { let { req, res, next} = this.requestData } } }, docs: { StatType: { [TYPE]: `A type of statistic associated with people`, PHYSICAL: `Physical attributes`, MENTAL: `Mental attributes` }, Person: { [TYPE]: `Represents a person`, personId: `Unique id of the person in question`, name: `The name of the person`, stats: `Allows you to query the stats of a person based on type` }, Query: { [TYPE]: 'Top level query desc.', findPerson: `Searches the system for the specified user` } } };
853var Person = LF.build(PersonDef), p = new Person({name: 'Brielle'})
854Person.getProp('stats',true,{requestData:{req:1,res:2,next:3}})
855var Broke = LF.build({name: 'Broke', schema: gql`type Broke {name: String}`, resolvers:{}, docs:{}})
856var t = LF.validateTemplate({name: '',  type: GQLBase, resolvers: {}, docs: {}, schema: ''});
857*/
858</code></pre>
      </article>
  </section>
861
862
863
864
865</div>
866
867<br class="clear">
868
869<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.
871</footer>
872
873<script>prettyPrint();</script>
874<script src="scripts/linenumber.js"></script>
875</body>
876</html>