@nyteshade/lattice-legacy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>GQLBase - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <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"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <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> </nav> <div id="main"> <h1 class="page-title">GQLBase</h1> <section> <header> <h2> GQLBase </h2> </header> <article> <div class="container-overview"> <div class="section-method"> <h4 class="name" id="GQLBase"><span class="type-signature"></span>new GQLBase<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>All GraphQL Type objects used in this system are assumed to have extended<br>from this class. An instance of this class can be used to wrap an existing<br>structure if you have one.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line197">line 197</a> </li></ul></dd> </dl> </div> </div> <h3 class="subsection-title">Classes</h3> <dl> <dt><a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></dt> <dd></dd> </dl> <h3 class="subsection-title">Members</h3> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80%5B_PROXY_HANDLER%5D"><span class="type-signature">(static, constant) </span>⬇︎⠀[_PROXY_HANDLER]<span class="type-signature"> :Object</span></h4> <div class="description"> <p>If ES6 Proxies are supported in your execution environment, all GQLBase<br>extended classes are also proxies. By default the internal proxy handler<br>provides backwards compatibility with the removal of the default getters<br>and setters for the 'model' property as long as you do not define a<br>top level 'model' property of your own.</p> </div> <dl class="details"> <dt class="tag-since">Since:</dt> <dd class="tag-since"><ul class="dummy"><li>2.5.0</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1059">line 1059</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>Object</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80ADJACENT_FILE"><span class="type-signature">(static, constant) </span>⬇︎⠀ADJACENT_FILE<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line833">line 833</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><code>GQLBase#SCHEMA</code></li> </ul> </dd> </dl> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_CLASS"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_CLASS<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for a class description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1172">line 1172</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_FIELDS"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_FIELDS<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for a type field description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1186">line 1186</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_MUTATION"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_MUTATION<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for the top level mutation<br>description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1229">line 1229</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_MUTATORS"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_MUTATORS<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for a mutator description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1259">line 1259</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_MUTATORS"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_MUTATORS<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for a mutator description</p> </div> <dl class="details"> <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>Use `DOC_MUTATIONS` instead</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1244">line 1244</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_QUERIES"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_QUERIES<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for a query description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1215">line 1215</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_QUERY"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_QUERY<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for the top level query<br>description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1200">line 1200</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_SUBSCRIPTION"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_SUBSCRIPTION<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for the top level subscription<br>description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1273">line 1273</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80DOC_SUBSCRIPTIONS"><span class="type-signature">(static, constant) </span>⬇︎⠀DOC_SUBSCRIPTIONS<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant key used to identify a comment for a subscription description</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1288">line 1288</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80EVENT_MODEL_HAS_BEEN_SET"><span class="type-signature">(static, constant) </span>⬇︎⠀EVENT_MODEL_HAS_BEEN_SET<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant used to register an event listener for when the internal<br>model object is assigned a new value. This event fires after the model<br>is set.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1125">line 1125</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80EVENT_MODEL_PROP_CHANGE"><span class="type-signature">(static, constant) </span>⬇︎⠀EVENT_MODEL_PROP_CHANGE<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant used to register an event listener for when a property of the<br>internal model object is set to a new or intial value.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1141">line 1141</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80EVENT_MODEL_PROP_DELETE"><span class="type-signature">(static, constant) </span>⬇︎⠀EVENT_MODEL_PROP_DELETE<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant used to register an event listener for when a property of the<br>internal model object has been deleted. This event fires after the value<br>has been deleted.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1156">line 1156</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80EVENT_MODEL_WILL_BE_SET"><span class="type-signature">(static, constant) </span>⬇︎⠀EVENT_MODEL_WILL_BE_SET<span class="type-signature"> :string</span></h4> <div class="description"> <p>A constant used to register an event listener for when the internal<br>model object is assigned a new value. This event fires before the model<br>is set. Changes to the model value at this point will affect the contents<br>before the value assignment takes place.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1108">line 1108</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>string</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80GQL_TYPE"><span class="type-signature">(static, constant) </span>⬇︎⠀GQL_TYPE<span class="type-signature"></span></h4> <div class="description"> <p>Determines the default type targeted by this GQLBase class. Any<br>type will technically be valid but only will trigger special behavior</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line849">line 849</a> </li></ul></dd> </dl> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80joinLines"><span class="type-signature">(static, constant) </span>⬇︎⠀joinLines<span class="type-signature"> :function</span></h4> <div class="description"> <p>A shortcut to the utils/joinLines function to make it easier to get<br>the tools to write docs for your types in a friendly fashion.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1302">line 1302</a> </li></ul></dd> </dl> <h5>Type:</h5> <ul> <li> <span class="param-type"><code>function</code></span> </li> </ul> </div> <div class="section-members"> <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80module"><span class="type-signature">(static, constant) </span>⬇︎⠀module<span class="type-signature"></span></h4> <div class="description"> <p>Returns the module object where your class is created. This needs to be<br>defined on your class, as a static getter, in the FILE where you are<br>defining your Class definition.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line910">line 910</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="https://nodejs.org/api/modules.html">https://nodejs.org/api/modules.html</a></li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <div class="section-method"> <h4 class="name" id=".apiDocs"><span class="type-signature">(static) </span>apiDocs<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> <p>Until such time as the reference implementation of Facebook's GraphQL<br>SDL AST parser supports comments, or until we take advantage of Apollo's<br>AST parser, this is how comments will be applied to a built schema.</p> <p>Several constants are defined on the GQLBase object itself, and thereby<br>all its subclasses. They pertain to how to define description fields<br>for various parts of your GQL implementation.</p> <pre class="prettyprint source"><code>// 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 }</code></pre><p>To make writing code easier, the <code>joinLines()</code> template function is<br>available so your source code can look nice and neat and your descriptions<br>won't get annoying line breaks and spaces as part of that process.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line651">line 651</a> </li></ul></dd> </dl> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code>Object</code></span> </dd> </dl> <div class="param-desc"> <p>an object with various keys and values denoting<br>description fields that should be applied to the final schema object</p> </div> </div> </div> <div class="section-method"> <h4 class="name" id=".%E2%8C%BE%E2%A0%80getMergedRoot"><span class="type-signature">(static) </span>⌾⠀getMergedRoot<span class="signature">(requestData)</span><span class="type-signature"> → {Object}</span></h4> <div class="description"> <p>An simple pass-thru method for fetching a types merged root object.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line1317">line 1317</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>requestData</code></td> <td class="type"> <span class="param-type"><code>Object</code></span> </td> <td class="description last"> <p>an object containing the request data such as<br>request, response or graphql context info that should be passed along to<br>each of the resolver creators</p> </td> </tr> </tbody> </table> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code>Object</code></span> </dd> </dl> <div class="param-desc"> <p>the merged root object with all the query, mutation and<br>subscription resolvers defined and created within.</p> </div> </div> </div> <div class="section-method"> <h4 class="name" id=".%E2%8C%BE%E2%A0%80getProp"><span class="type-signature">(static) </span>⌾⠀getProp<span class="signature">(propName, bindGetters, bindTo)</span><span class="type-signature"> → {mixed}</span></h4> <div class="description"> <p>The static version of getProp reads into the prototype to find the field<br>that is desired. If the field is either a getter or a initializer (see<br>class properties descriptors), then the option to bind that to either the<br>prototype object or one of your choosing is available.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line610">line 610</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>propName</code></td> <td class="type"> <span class="param-type"><code>string</code></span> | <span class="param-type"><code>Symbol</code></span> </td> <td class="description last"> <p>a string or Symbol denoting the name of<br>the property or field you desire</p> </td> </tr> <tr> <td class="name"><code>bindGetters</code></td> <td class="type"> <span class="param-type"><code>boolean</code></span> </td> <td class="description last"> <p>true if a resulting <code>getter</code> or <code>initializer</code><br>should be bound to the prototype or other object</p> </td> </tr> <tr> <td class="name"><code>bindTo</code></td> <td class="type"> <span class="param-type"><code>mixed</code></span> </td> <td class="description last"> <p>the object to which to bind the <code>getter</code> or<br><code>initializer</code> functions to if other than the class prototype.</p> </td> </tr> </tbody> </table> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code>mixed</code></span> </dd> </dl> <div class="param-desc"> <p>a <code>Function</code> or other mixed value making up the property<br>name requested</p> </div> </div> </div> <div class="section-method"> <h4 class="name" id=".%E2%8C%BE%E2%A0%80getResolver"><span class="type-signature">(static) </span>⌾⠀getResolver<span class="signature">(resolverName, requestData)</span><span class="type-signature"> → {function}</span></h4> <div class="description"> <p>Resolvers are created in a number of different ways. OOP design<br>dictates that instances of a created class will handle field<br>resolvers, but query, mutation and subscription resolvers are<br>typically what creates these instances.</p> <p>Since a resolver can be created using <code>@mutator/@subscriptor/@resolver</code><br>or via method on a object returned from <code>RESOLVERS()</code>, <code>MUTATORS()</code> or<br><code>SUBSCRIPTIONS()</code>, there should be an easy to use way to fetch a<br>resolver by name; if for nothing else, code reuse.</p> <p>Pass the name of the resolver to the function and optionally pass a<br>requestData object. The <code>getMergedRoot()</code> method will build an object<br>containing all the root resolvers for the type, bound to the supplied<br><code>requestData</code> object. It is from this object that <code>resolverName</