1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <meta name="viewport" content="width=device-width,initial-scale=1">
|
6 | <title>GQLBaseEnv - Documentation</title>
|
7 |
|
8 | <script src="scripts/prettify/prettify.js"></script>
|
9 | <script src="scripts/prettify/lang-css.js"></script>
|
10 | |
11 |
|
12 |
|
13 | <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
14 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
15 | <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">
|
21 | <div class="navicon"></div>
|
22 | </label>
|
23 |
|
24 | <label for="nav-trigger" class="overlay"></label>
|
25 |
|
26 | <nav>
|
27 | <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">
|
31 |
|
32 | <h1 class="page-title">GQLBaseEnv</h1>
|
33 |
|
34 |
|
35 |
|
36 |
|
37 |
|
38 |
|
39 |
|
40 | <section>
|
41 |
|
42 | <header>
|
43 |
|
44 | <h2>
|
45 | GQLBaseEnv
|
46 | </h2>
|
47 |
|
48 |
|
49 | </header>
|
50 |
|
51 | <article>
|
52 | <div class="container-overview">
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 | <dl class="details">
|
60 |
|
61 |
|
62 |
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 | <dt class="tag-source">Source:</dt>
|
87 | <dd class="tag-source"><ul class="dummy"><li>
|
88 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line93">line 93</a>
|
89 | </li></ul></dd>
|
90 |
|
91 |
|
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 | </dl>
|
98 |
|
99 |
|
100 |
|
101 |
|
102 | </div>
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 | <h3 class="subsection-title">Members</h3>
|
116 |
|
117 |
|
118 |
|
119 | <div class="section-members">
|
120 | <h4 class="name" id=".MODEL_KEY"><span class="type-signature">(static, constant) </span>MODEL_KEY<span class="type-signature"> :Symbol</span></h4>
|
121 |
|
122 |
|
123 |
|
124 |
|
125 | <div class="description">
|
126 | <p>A <code>Symbol</code> used as a key to store the backing model data. Designed as a<br>way to separate model data and GraphQL property accessors into logical bits.</p>
|
127 | </div>
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 | <dl class="details">
|
134 |
|
135 |
|
136 |
|
137 |
|
138 |
|
139 |
|
140 |
|
141 |
|
142 |
|
143 |
|
144 |
|
145 |
|
146 |
|
147 |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 |
|
158 |
|
159 |
|
160 | <dt class="tag-source">Source:</dt>
|
161 | <dd class="tag-source"><ul class="dummy"><li>
|
162 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line61">line 61</a>
|
163 | </li></ul></dd>
|
164 |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 | </dl>
|
172 |
|
173 |
|
174 |
|
175 | <h5>Type:</h5>
|
176 | <ul>
|
177 | <li>
|
178 |
|
179 | <span class="param-type"><code>Symbol</code></span>
|
180 |
|
181 |
|
182 | </li>
|
183 | </ul>
|
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 | </div>
|
190 |
|
191 |
|
192 |
|
193 | <div class="section-members">
|
194 | <h4 class="name" id="~AUTO_PROPS"><span class="type-signature">(inner, constant) </span>AUTO_PROPS<span class="type-signature"> :Symbol</span></h4>
|
195 |
|
196 |
|
197 |
|
198 |
|
199 | <div class="description">
|
200 | <p>A Symbol used to identify calls to @Properties for properties generated<br>automatically upon instance creation.</p>
|
201 | </div>
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 | <dl class="details">
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
|
234 | <dt class="tag-source">Source:</dt>
|
235 | <dd class="tag-source"><ul class="dummy"><li>
|
236 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line92">line 92</a>
|
237 | </li></ul></dd>
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 | </dl>
|
246 |
|
247 |
|
248 |
|
249 | <h5>Type:</h5>
|
250 | <ul>
|
251 | <li>
|
252 |
|
253 | <span class="param-type"><code>Symbol</code></span>
|
254 |
|
255 |
|
256 | </li>
|
257 | </ul>
|
258 |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 | </div>
|
264 |
|
265 |
|
266 |
|
267 | <div class="section-members">
|
268 | <h4 class="name" id="~GETTERS"><span class="type-signature">(inner, constant) </span>GETTERS<span class="type-signature"> :Symbol</span></h4>
|
269 |
|
270 |
|
271 |
|
272 |
|
273 | <div class="description">
|
274 | <p>A Symbol used to identify calls to @Getters for properties generated<br>via decorator. These are stored in <class>[META_KEY][GETTERS]</p>
|
275 | </div>
|
276 |
|
277 |
|
278 |
|
279 |
|
280 |
|
281 | <dl class="details">
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
|
299 |
|
300 |
|
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 |
|
307 |
|
308 | <dt class="tag-source">Source:</dt>
|
309 | <dd class="tag-source"><ul class="dummy"><li>
|
310 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line103">line 103</a>
|
311 | </li></ul></dd>
|
312 |
|
313 |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 | </dl>
|
320 |
|
321 |
|
322 |
|
323 | <h5>Type:</h5>
|
324 | <ul>
|
325 | <li>
|
326 |
|
327 | <span class="param-type"><code>Symbol</code></span>
|
328 |
|
329 |
|
330 | </li>
|
331 | </ul>
|
332 |
|
333 |
|
334 |
|
335 |
|
336 |
|
337 | </div>
|
338 |
|
339 |
|
340 |
|
341 | <div class="section-members">
|
342 | <h4 class="name" id="~META_KEY"><span class="type-signature">(inner, constant) </span>META_KEY<span class="type-signature"> :Symbol</span></h4>
|
343 |
|
344 |
|
345 |
|
346 |
|
347 | <div class="description">
|
348 | <p>A nameless Symbol for use as a key to the internal decorator storage</p>
|
349 | </div>
|
350 |
|
351 |
|
352 |
|
353 |
|
354 |
|
355 | <dl class="details">
|
356 |
|
357 |
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 |
|
364 |
|
365 |
|
366 |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 |
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 |
|
380 |
|
381 |
|
382 | <dt class="tag-source">Source:</dt>
|
383 | <dd class="tag-source"><ul class="dummy"><li>
|
384 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line82">line 82</a>
|
385 | </li></ul></dd>
|
386 |
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 | </dl>
|
394 |
|
395 |
|
396 |
|
397 | <h5>Type:</h5>
|
398 | <ul>
|
399 | <li>
|
400 |
|
401 | <span class="param-type"><code>Symbol</code></span>
|
402 |
|
403 |
|
404 | </li>
|
405 | </ul>
|
406 |
|
407 |
|
408 |
|
409 |
|
410 |
|
411 | </div>
|
412 |
|
413 |
|
414 |
|
415 | <div class="section-members">
|
416 | <h4 class="name" id="~PROPS"><span class="type-signature">(inner, constant) </span>PROPS<span class="type-signature"> :Symbol</span></h4>
|
417 |
|
418 |
|
419 |
|
420 |
|
421 | <div class="description">
|
422 | <p>A Symbol used to identify calls to @Properties for properties generated<br>via decorator. These are stored in <class>[META_KEY][PROPS]</p>
|
423 | </div>
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 | <dl class="details">
|
430 |
|
431 |
|
432 |
|
433 |
|
434 |
|
435 |
|
436 |
|
437 |
|
438 |
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 |
|
447 |
|
448 |
|
449 |
|
450 |
|
451 |
|
452 |
|
453 |
|
454 |
|
455 |
|
456 | <dt class="tag-source">Source:</dt>
|
457 | <dd class="tag-source"><ul class="dummy"><li>
|
458 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line125">line 125</a>
|
459 | </li></ul></dd>
|
460 |
|
461 |
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 | </dl>
|
468 |
|
469 |
|
470 |
|
471 | <h5>Type:</h5>
|
472 | <ul>
|
473 | <li>
|
474 |
|
475 | <span class="param-type"><code>Symbol</code></span>
|
476 |
|
477 |
|
478 | </li>
|
479 | </ul>
|
480 |
|
481 |
|
482 |
|
483 |
|
484 |
|
485 | </div>
|
486 |
|
487 |
|
488 |
|
489 | <div class="section-members">
|
490 | <h4 class="name" id="~REQ_DATA_KEY"><span class="type-signature">(inner, constant) </span>REQ_DATA_KEY<span class="type-signature"> :Symbol</span></h4>
|
491 |
|
492 |
|
493 |
|
494 |
|
495 | <div class="description">
|
496 | <p>A <code>Symbol</code> used as a key to store the request data for an instance of the<br>GQLBase object in question.</p>
|
497 | </div>
|
498 |
|
499 |
|
500 |
|
501 |
|
502 |
|
503 | <dl class="details">
|
504 |
|
505 |
|
506 |
|
507 |
|
508 |
|
509 |
|
510 |
|
511 |
|
512 |
|
513 |
|
514 |
|
515 |
|
516 |
|
517 |
|
518 |
|
519 |
|
520 |
|
521 |
|
522 |
|
523 |
|
524 |
|
525 |
|
526 |
|
527 |
|
528 |
|
529 |
|
530 | <dt class="tag-source">Source:</dt>
|
531 | <dd class="tag-source"><ul class="dummy"><li>
|
532 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line71">line 71</a>
|
533 | </li></ul></dd>
|
534 |
|
535 |
|
536 |
|
537 |
|
538 |
|
539 |
|
540 |
|
541 | </dl>
|
542 |
|
543 |
|
544 |
|
545 | <h5>Type:</h5>
|
546 | <ul>
|
547 | <li>
|
548 |
|
549 | <span class="param-type"><code>Symbol</code></span>
|
550 |
|
551 |
|
552 | </li>
|
553 | </ul>
|
554 |
|
555 |
|
556 |
|
557 |
|
558 |
|
559 | </div>
|
560 |
|
561 |
|
562 |
|
563 | <div class="section-members">
|
564 | <h4 class="name" id="~SETTERS"><span class="type-signature">(inner, constant) </span>SETTERS<span class="type-signature"> :Symbol</span></h4>
|
565 |
|
566 |
|
567 |
|
568 |
|
569 | <div class="description">
|
570 | <p>A Symbol used to identify calls to @Setters for properties generated<br>via decorator. These are stored in <class>[META_KEY][SETTERS]</p>
|
571 | </div>
|
572 |
|
573 |
|
574 |
|
575 |
|
576 |
|
577 | <dl class="details">
|
578 |
|
579 |
|
580 |
|
581 |
|
582 |
|
583 |
|
584 |
|
585 |
|
586 |
|
587 |
|
588 |
|
589 |
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 |
|
602 |
|
603 |
|
604 | <dt class="tag-source">Source:</dt>
|
605 | <dd class="tag-source"><ul class="dummy"><li>
|
606 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line114">line 114</a>
|
607 | </li></ul></dd>
|
608 |
|
609 |
|
610 |
|
611 |
|
612 |
|
613 |
|
614 |
|
615 | </dl>
|
616 |
|
617 |
|
618 |
|
619 | <h5>Type:</h5>
|
620 | <ul>
|
621 | <li>
|
622 |
|
623 | <span class="param-type"><code>Symbol</code></span>
|
624 |
|
625 |
|
626 | </li>
|
627 | </ul>
|
628 |
|
629 |
|
630 |
|
631 |
|
632 |
|
633 | </div>
|
634 |
|
635 |
|
636 |
|
637 |
|
638 |
|
639 | <h3 class="subsection-title">Methods</h3>
|
640 |
|
641 |
|
642 |
|
643 | <div class="section-method">
|
644 |
|
645 |
|
646 |
|
647 | <h4 class="name" id="~notDefined"><span class="type-signature">(inner) </span>notDefined<span class="signature">(keyToTest, keySupplied, instance)</span><span class="type-signature"> → {Boolean}</span></h4>
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 | <div class="description">
|
654 | <p>Simple function to check if a supplied key matches a string of your<br>choosing and that string is not a defined property on the instance<br>passed to the check.</p>
|
655 | </div>
|
656 |
|
657 |
|
658 |
|
659 |
|
660 |
|
661 | <dl class="details">
|
662 |
|
663 |
|
664 |
|
665 |
|
666 | <dt class="tag-since">Since:</dt>
|
667 | <dd class="tag-since"><ul class="dummy"><li>2.5.0</li></ul></dd>
|
668 |
|
669 |
|
670 |
|
671 |
|
672 |
|
673 |
|
674 |
|
675 |
|
676 |
|
677 |
|
678 |
|
679 |
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 |
|
690 |
|
691 | <dt class="tag-source">Source:</dt>
|
692 | <dd class="tag-source"><ul class="dummy"><li>
|
693 | <a href="GQLBase.js.html">GQLBase.js</a>, <a href="GQLBase.js.html#line33">line 33</a>
|
694 | </li></ul></dd>
|
695 |
|
696 |
|
697 |
|
698 |
|
699 |
|
700 |
|
701 |
|
702 | </dl>
|
703 |
|
704 |
|
705 |
|
706 |
|
707 |
|
708 |
|
709 |
|
710 |
|
711 |
|
712 | <h5>Parameters:</h5>
|
713 |
|
714 |
|
715 | <table class="params">
|
716 | <thead>
|
717 | <tr>
|
718 |
|
719 | <th>Name</th>
|
720 |
|
721 |
|
722 | <th>Type</th>
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 | <th class="last">Description</th>
|
729 | </tr>
|
730 | </thead>
|
731 |
|
732 | <tbody>
|
733 |
|
734 |
|
735 | <tr>
|
736 |
|
737 | <td class="name"><code>keyToTest</code></td>
|
738 |
|
739 |
|
740 | <td class="type">
|
741 |
|
742 |
|
743 | <span class="param-type"><code>string</code></span>
|
744 |
|
745 |
|
746 |
|
747 | </td>
|
748 |
|
749 |
|
750 |
|
751 |
|
752 |
|
753 | <td class="description last">
|
754 | <p>a String denoting the property you wish to test</p>
|
755 |
|
756 | </td>
|
757 | </tr>
|
758 |
|
759 |
|
760 |
|
761 | <tr>
|
762 |
|
763 | <td class="name"><code>keySupplied</code></td>
|
764 |
|
765 |
|
766 | <td class="type">
|
767 |
|
768 |
|
769 | <span class="param-type"><code>mixed</code></span>
|
770 |
|
771 |
|
772 |
|
773 | </td>
|
774 |
|
775 |
|
776 |
|
777 |
|
778 |
|
779 | <td class="description last">
|
780 | <p>a value, coerced <code>toString()</code>, to compare to<br><code>keyToTest</code></p>
|
781 |
|
782 | </td>
|
783 | </tr>
|
784 |
|
785 |
|
786 |
|
787 | <tr>
|
788 |
|
789 | <td class="name"><code>instance</code></td>
|
790 |
|
791 |
|
792 | <td class="type">
|
793 |
|
794 |
|
795 | <span class="param-type"><code>mixed</code></span>
|
796 |
|
797 |
|
798 |
|
799 | </td>
|
800 |
|
801 |
|
802 |
|
803 |
|
804 |
|
805 | <td class="description last">
|
806 | <p>an object instance to check <code>hasOwnProperty</code> on for<br>the <code>keyToTest</code> supplied.</p>
|
807 |
|
808 | </td>
|
809 | </tr>
|
810 |
|
811 |
|
812 | </tbody>
|
813 | </table>
|
814 |
|
815 |
|
816 |
|
817 |
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 |
|
827 |
|
828 | <div class="section-returns">
|
829 | <h5>Returns:</h5>
|
830 |
|
831 |
|
832 |
|
833 | <dl class="param-type">
|
834 | <dt>
|
835 | Type:
|
836 | </dt>
|
837 | <dd>
|
838 |
|
839 | <span class="param-type"><code>Boolean</code></span>
|
840 |
|
841 |
|
842 | </dd>
|
843 | </dl>
|
844 |
|
845 |
|
846 | <div class="param-desc">
|
847 | <p>true if the property matches the supplied key and that<br>property is not an ownedProperty of the instance supplied.</p>
|
848 | </div>
|
849 |
|
850 |
|
851 | </div>
|
852 |
|
853 |
|
854 |
|
855 | </div>
|
856 |
|
857 |
|
858 |
|
859 |
|
860 |
|
861 |
|
862 | </article>
|
863 |
|
864 | </section>
|
865 |
|
866 |
|
867 |
|
868 |
|
869 | </div>
|
870 |
|
871 | <br class="clear">
|
872 |
|
873 | <footer>
|
874 | 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.
|
875 | </footer>
|
876 |
|
877 | <script>prettyPrint();</script>
|
878 | <script src="scripts/linenumber.js"></script>
|
879 | </body>
|
880 | </html> |
\ | No newline at end of file |