UNPKG

42 kBHTMLView Raw
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>GQLEnum - Documentation</title>
7
8 <script src="scripts/prettify/prettify.js"></script>
9 <script src="scripts/prettify/lang-css.js"></script>
10 <!--[if lt IE 9]>
11 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12 <![endif]-->
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">GQLEnum</h1>
33
34
35
36
37
38
39
40<section>
41
42<header>
43
44 <h2>
45 GQLEnum
46 </h2>
47
48
49</header>
50
51<article>
52 <div class="container-overview">
53
54
55<div class="section-method">
56
57
58
59 <h4 class="name" id="GQLEnum"><span class="type-signature"></span>new GQLEnum<span class="signature">()</span><span class="type-signature"></span></h4>
60
61
62
63
64
65<div class="description">
66 <p>GraphQL Enum types can be a bit picky when it comes to how scalar types<br>equate to enum values. Lattice makes this easier by allowing you to specify<br>a value or the key when your enum has a value other than the key; GraphQL<br>does not allow this by default.</p>
67<p>Further more, when instantiating a GQLEnum type, you can pass a string or<br>value matching the enum key or value or you can pass an object with key of<br>value and the value being either the enum key or value. If any of those<br>things match, then your <code>instance.value</code> will equate to the enum's key. If,<br>on the other hand, your supplied values do not match then <code>instance.value</code><br>will be <code>null</code>.</p>
68</div>
69
70
71
72
73
74<dl class="details">
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101 <dt class="tag-source">Source:</dt>
102 <dd class="tag-source"><ul class="dummy"><li>
103 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line20">line 20</a>
104 </li></ul></dd>
105
106
107
108
109
110
111
112</dl>
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136</div>
137
138 </div>
139
140
141
142
143
144
145
146
147
148
149
150
151 <h3 class="subsection-title">Members</h3>
152
153
154
155<div class="section-members">
156<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>
157
158
159
160
161<div class="description">
162 <p>Determines the default type targeted by this GQLBase class. Any<br>type will technically be valid but only will trigger special behavior</p>
163</div>
164
165
166
167
168
169<dl class="details">
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196 <dt class="tag-source">Source:</dt>
197 <dd class="tag-source"><ul class="dummy"><li>
198 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line113">line 113</a>
199 </li></ul></dd>
200
201
202
203
204
205
206
207</dl>
208
209
210
211
212
213
214
215</div>
216
217
218
219
220
221 <h3 class="subsection-title">Methods</h3>
222
223
224
225<div class="section-method">
226
227
228
229 <h4 class="name" id="..get"><span class="type-signature">(static) </span>.get<span class="signature">(obj, key)</span><span class="type-signature"> &rarr; {mixed}</span></h4>
230
231
232
233
234
235<div class="description">
236 <p>Get handler for the Map backed Array Proxy</p>
237</div>
238
239
240
241
242
243<dl class="details">
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270 <dt class="tag-source">Source:</dt>
271 <dd class="tag-source"><ul class="dummy"><li>
272 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line258">line 258</a>
273 </li></ul></dd>
274
275
276
277
278
279
280
281</dl>
282
283
284
285
286
287
288
289
290
291 <h5>Parameters:</h5>
292
293
294<table class="params">
295 <thead>
296 <tr>
297
298 <th>Name</th>
299
300
301 <th>Type</th>
302
303
304
305
306
307 <th class="last">Description</th>
308 </tr>
309 </thead>
310
311 <tbody>
312
313
314 <tr>
315
316 <td class="name"><code>obj</code></td>
317
318
319 <td class="type">
320
321
322<span class="param-type"><code>mixed</code></span>
323
324
325
326 </td>
327
328
329
330
331
332 <td class="description last">
333 <p>the object targeted by the Proxy</p>
334
335 </td>
336 </tr>
337
338
339
340 <tr>
341
342 <td class="name"><code>key</code></td>
343
344
345 <td class="type">
346
347
348<span class="param-type"><code>string</code></span>
349
350
351
352 </td>
353
354
355
356
357
358 <td class="description last">
359 <p><code>key</code> of the value being requested</p>
360
361 </td>
362 </tr>
363
364
365 </tbody>
366</table>
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381<div class="section-returns">
382<h5>Returns:</h5>
383
384
385
386<dl class="param-type">
387 <dt>
388 Type:
389 </dt>
390 <dd>
391
392<span class="param-type"><code>mixed</code></span>
393
394
395 </dd>
396</dl>
397
398
399<div class="param-desc">
400 <p>the <code>value</code> being requested</p>
401</div>
402
403
404</div>
405
406
407
408</div>
409
410
411<div class="section-method">
412
413
414
415 <h4 class="name" id="..set"><span class="type-signature">(static) </span>.set<span class="signature">(obj, key, value)</span><span class="type-signature"></span></h4>
416
417
418
419
420
421<div class="description">
422 <p>Set handler for the Map backed Array Proxy.</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="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line276">line 276</a>
459 </li></ul></dd>
460
461
462
463
464
465
466
467</dl>
468
469
470
471
472
473
474
475
476
477 <h5>Parameters:</h5>
478
479
480<table class="params">
481 <thead>
482 <tr>
483
484 <th>Name</th>
485
486
487 <th>Type</th>
488
489
490
491
492
493 <th class="last">Description</th>
494 </tr>
495 </thead>
496
497 <tbody>
498
499
500 <tr>
501
502 <td class="name"><code>obj</code></td>
503
504
505 <td class="type">
506
507
508<span class="param-type"><code>mixed</code></span>
509
510
511
512 </td>
513
514
515
516
517
518 <td class="description last">
519 <p>the object the Proxy is targeting</p>
520
521 </td>
522 </tr>
523
524
525
526 <tr>
527
528 <td class="name"><code>key</code></td>
529
530
531 <td class="type">
532
533
534<span class="param-type"><code>string</code></span>
535
536
537
538 </td>
539
540
541
542
543
544 <td class="description last">
545 <p>a string <code>key</code> being set</p>
546
547 </td>
548 </tr>
549
550
551
552 <tr>
553
554 <td class="name"><code>value</code></td>
555
556
557 <td class="type">
558
559
560<span class="param-type"><code>mixed</code></span>
561
562
563
564 </td>
565
566
567
568
569
570 <td class="description last">
571 <p>the <code>value</code> being assigned to <code>key</code></p>
572
573 </td>
574 </tr>
575
576
577 </tbody>
578</table>
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595</div>
596
597
598<div class="section-method">
599
600
601
602 <h4 class="name" id=".valueFor"><span class="type-signature">(static) </span>valueFor<span class="signature">(value, deprecationReason, description)</span><span class="type-signature"> &rarr; {Object}</span></h4>
603
604
605
606
607
608<div class="description">
609 <p>Shorthand method to generate a GraphQLEnumValueDefinition implementation<br>object. Use this for building and customizing your <code>values</code> key/value<br>object in your child classes.</p>
610</div>
611
612
613
614
615
616<dl class="details">
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643 <dt class="tag-source">Source:</dt>
644 <dd class="tag-source"><ul class="dummy"><li>
645 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line156">line 156</a>
646 </li></ul></dd>
647
648
649
650
651
652
653
654</dl>
655
656
657
658
659
660
661
662
663
664 <h5>Parameters:</h5>
665
666
667<table class="params">
668 <thead>
669 <tr>
670
671 <th>Name</th>
672
673
674 <th>Type</th>
675
676
677
678
679
680 <th class="last">Description</th>
681 </tr>
682 </thead>
683
684 <tbody>
685
686
687 <tr>
688
689 <td class="name"><code>value</code></td>
690
691
692 <td class="type">
693
694
695<span class="param-type"><code>mixed</code></span>
696
697
698
699 </td>
700
701
702
703
704
705 <td class="description last">
706 <p>any nonstandard value you wish your enum to have</p>
707
708 </td>
709 </tr>
710
711
712
713 <tr>
714
715 <td class="name"><code>deprecationReason</code></td>
716
717
718 <td class="type">
719
720
721<span class="param-type"><code>String</code></span>
722
723
724
725 </td>
726
727
728
729
730
731 <td class="description last">
732 <p>an optional reason to deprecate an enum</p>
733
734 </td>
735 </tr>
736
737
738
739 <tr>
740
741 <td class="name"><code>description</code></td>
742
743
744 <td class="type">
745
746
747<span class="param-type"><code>String</code></span>
748
749
750
751 </td>
752
753
754
755
756
757 <td class="description last">
758 <p>a non Lattice standard way to write a comment</p>
759
760 </td>
761 </tr>
762
763
764 </tbody>
765</table>
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780<div class="section-returns">
781<h5>Returns:</h5>
782
783
784
785<dl class="param-type">
786 <dt>
787 Type:
788 </dt>
789 <dd>
790
791<span class="param-type"><code>Object</code></span>
792
793
794 </dd>
795</dl>
796
797
798<div class="param-desc">
799 <p>an object that conforms to the GraphQLEnumValueDefinition<br>defined here http://graphql.org/graphql-js/type/#graphqlenumtype</p>
800</div>
801
802
803</div>
804
805
806
807</div>
808
809
810<div class="section-method">
811
812
813
814 <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80enums"><span class="type-signature">(static) </span>⬇︎⠀enums<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;Symbol>}</span></h4>
815
816
817
818
819
820<div class="description">
821 <p>For easier use within JavaScript, the static enums method provides a<br>Symbol backed solution for each of the enums defined. Each <code>Symbol</code><br>instance is wrapped in Object so as to allow some additional properties<br>to be written to it.</p>
822</div>
823
824
825
826
827
828<dl class="details">
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855 <dt class="tag-source">Source:</dt>
856 <dd class="tag-source"><ul class="dummy"><li>
857 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line184">line 184</a>
858 </li></ul></dd>
859
860
861
862
863
864
865
866</dl>
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888<div class="section-returns">
889<h5>Returns:</h5>
890
891
892
893<dl class="param-type">
894 <dt>
895 Type:
896 </dt>
897 <dd>
898
899<span class="param-type"><code>Array.&lt;Symbol></code></span>
900
901
902 </dd>
903</dl>
904
905
906<div class="param-desc">
907 <p>an array of modified Symbols for each enum<br>variation defined.</p>
908</div>
909
910
911</div>
912
913
914
915</div>
916
917
918<div class="section-method">
919
920
921
922 <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80name"><span class="type-signature">(static) </span>⬇︎⠀name<span class="signature">()</span><span class="type-signature"> &rarr; {mixed}</span></h4>
923
924
925
926
927
928<div class="description">
929 <p>Retrieves the actual symbol stored name property from the internal<br>model object for this enum instance. That is a mouthfull, but it<br>basically means that if your enum is something like:</p>
930<pre class="prettyprint source"><code>enum Person { TALL, SHORT }</code></pre><p>and you create an instance using any of the following</p>
931<pre class="prettyprint source"><code>p = new Person('TALL')
932p = new Person(valueFor('TALL'))
933p = new Person({value: 'TALL'})</code></pre><p>that your response to <code>p.name</code> will equate to <code>TALL</code>.</p>
934</div>
935
936
937
938
939
940<dl class="details">
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967 <dt class="tag-source">Source:</dt>
968 <dd class="tag-source"><ul class="dummy"><li>
969 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line55">line 55</a>
970 </li></ul></dd>
971
972
973
974
975
976
977
978</dl>
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000<div class="section-returns">
1001<h5>Returns:</h5>
1002
1003
1004
1005<dl class="param-type">
1006 <dt>
1007 Type:
1008 </dt>
1009 <dd>
1010
1011<span class="param-type"><code>mixed</code></span>
1012
1013
1014 </dd>
1015</dl>
1016
1017
1018<div class="param-desc">
1019 <p>typically a String but any valid type supplied</p>
1020</div>
1021
1022
1023</div>
1024
1025
1026
1027</div>
1028
1029
1030<div class="section-method">
1031
1032
1033
1034 <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80value"><span class="type-signature">(static) </span>⬇︎⠀value<span class="signature">()</span><span class="type-signature"> &rarr; {mixed}</span></h4>
1035
1036
1037
1038
1039
1040<div class="description">
1041 <p>Much like the <code>.name</code> getter, the <code>.value</code> getter will typically<br>retreive the name of the enum key you are requesting. In rare cases<br>where you have defined values that differ from the name, the <code>.value</code><br>getter will retrieve that custom value from the <code>.value</code> property on<br>the symbol in question.</p>
1042<p>This should do the right thing even if you instantiated the instance<br>using the name.</p>
1043</div>
1044
1045
1046
1047
1048
1049<dl class="details">
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076 <dt class="tag-source">Source:</dt>
1077 <dd class="tag-source"><ul class="dummy"><li>
1078 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line88">line 88</a>
1079 </li></ul></dd>
1080
1081
1082
1083
1084
1085
1086
1087</dl>
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109<div class="section-returns">
1110<h5>Returns:</h5>
1111
1112
1113
1114<dl class="param-type">
1115 <dt>
1116 Type:
1117 </dt>
1118 <dd>
1119
1120<span class="param-type"><code>mixed</code></span>
1121
1122
1123 </dd>
1124</dl>
1125
1126
1127<div class="param-desc">
1128 <p>the value of the enum type; this in all likihood should<br>be a String or potentially an object</p>
1129</div>
1130
1131
1132</div>
1133
1134
1135
1136</div>
1137
1138
1139<div class="section-method">
1140
1141
1142
1143 <h4 class="name" id=".%E2%AC%87%EF%B8%8E%E2%A0%80values"><span class="type-signature">(static) </span>⬇︎⠀values<span class="signature">()</span><span class="type-signature"> &rarr; {Object|Null}</span></h4>
1144
1145
1146
1147
1148
1149<div class="description">
1150 <p>Each instance of GQLEnum must specify a map of keys and values. If this<br>method returns null or is not defined, the value of the enum will match<br>the name of the enum as per the reference implementation.</p>
1151<p>Example:</p>
1152<pre class="prettyprint source"><code> static get values(): ?Object {
1153 const { valueOf } = this;
1154
1155 return {
1156 NAME: valueOf(value)
1157 }
1158 }</code></pre>
1159</div>
1160
1161
1162
1163
1164
1165<dl class="details">
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192 <dt class="tag-source">Source:</dt>
1193 <dd class="tag-source"><ul class="dummy"><li>
1194 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line129">line 129</a>
1195 </li></ul></dd>
1196
1197
1198
1199
1200
1201
1202
1203</dl>
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225<div class="section-returns">
1226<h5>Returns:</h5>
1227
1228
1229
1230<dl class="param-type">
1231 <dt>
1232 Type:
1233 </dt>
1234 <dd>
1235
1236<span class="param-type"><code>Object</code></span>
1237|
1238
1239<span class="param-type"><code>Null</code></span>
1240
1241
1242 </dd>
1243</dl>
1244
1245
1246<div class="param-desc">
1247 <p>an object mapping with each key mapping to an object<br>possessing at least a value field, which in turn maps to the desired value</p>
1248</div>
1249
1250
1251</div>
1252
1253
1254
1255</div>
1256
1257
1258<div class="section-method">
1259
1260
1261
1262 <h4 class="name" id="GenerateEnumsProxyHandler"><span class="type-signature"></span>GenerateEnumsProxyHandler<span class="signature">(map)</span><span class="type-signature"> &rarr; {Object}</span></h4>
1263
1264
1265
1266
1267
1268<div class="description">
1269 <p>Due to the complexity of being able to access both the keys and values<br>properly for an enum type, a Map is used as the backing store. The handler<br>returned by this method is to be passed to a Proxy.</p>
1270</div>
1271
1272
1273
1274
1275
1276<dl class="details">
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303 <dt class="tag-source">Source:</dt>
1304 <dd class="tag-source"><ul class="dummy"><li>
1305 <a href="GQLEnum.js.html">GQLEnum.js</a>, <a href="GQLEnum.js.html#line244">line 244</a>
1306 </li></ul></dd>
1307
1308
1309
1310
1311
1312
1313
1314</dl>
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324 <h5>Parameters:</h5>
1325
1326
1327<table class="params">
1328 <thead>
1329 <tr>
1330
1331 <th>Name</th>
1332
1333
1334 <th>Type</th>
1335
1336
1337
1338
1339
1340 <th class="last">Description</th>
1341 </tr>
1342 </thead>
1343
1344 <tbody>
1345
1346
1347 <tr>
1348
1349 <td class="name"><code>map</code></td>
1350
1351
1352 <td class="type">
1353
1354
1355<span class="param-type"><code>Map</code></span>
1356
1357
1358
1359 </td>
1360
1361
1362
1363
1364
1365 <td class="description last">
1366 <p>the map containing the key&lt;-&gt;value and<br>value&lt;-&gt;key mappings; the true storage backing the array in question.</p>
1367
1368 </td>
1369 </tr>
1370
1371
1372 </tbody>
1373</table>
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388<div class="section-returns">
1389<h5>Returns:</h5>
1390
1391
1392
1393<dl class="param-type">
1394 <dt>
1395 Type:
1396 </dt>
1397 <dd>
1398
1399<span class="param-type"><code>Object</code></span>
1400
1401
1402 </dd>
1403</dl>
1404
1405
1406
1407</div>
1408
1409
1410
1411</div>
1412
1413
1414
1415
1416
1417
1418</article>
1419
1420</section>
1421
1422
1423
1424
1425</div>
1426
1427<br class="clear">
1428
1429<footer>
1430 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.
1431</footer>
1432
1433<script>prettyPrint();</script>
1434<script src="scripts/linenumber.js"></script>
1435</body>
1436</html>
\No newline at end of file