UNPKG

graphql-lattice/docs/decorators_ModelProperties.js.html

Version:
1<!DOCTYPE html>
2<html lang="en">
3<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <title>decorators/ModelProperties.js - Documentation</title>
7
  <script src="scripts/prettify/prettify.js"></script>
  <script src="scripts/prettify/lang-css.js"></script>
  <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  <![endif]-->
  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16</head>
17<body>
18
19<input type="checkbox" id="nav-trigger" class="nav-trigger" />
20<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
22</label>
23
24<label for="nav-trigger" class="overlay"></label>
25
26<nav>
  <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580asyncFn">⌾⠀asyncFn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580setPromise">⌾⠀setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html#setPromise">setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Deferred_exports.Deferred.html">Deferred</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DirectTypeAdd.html">DirectTypeAdd</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="FunctionExecutionError_FunctionExecutionError.html">FunctionExecutionError</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.html">GQLBase</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.apiDocs">apiDocs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getMergedRoot">⌾⠀getMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580IDLFilePath">⌾⠀IDLFilePath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580MUTATORS">⌾⠀MUTATORS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580RESOLVERS">⌾⠀RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580setupModel">⌾⠀setupModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580handler">⬇︎⠀handler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580SCHEMA">⬇︎⠀SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580applyAutoProps">⌾⠀applyAutoProps</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580callProp">⌾⠀callProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580extendModel">⌾⠀extendModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getModel">⌾⠀getModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580setModel">⌾⠀setModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580requestData">⬆︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580requestData">⬇︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~deleteProperty">deleteProperty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~set">set</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLEnum.html">GQLEnum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..get">.get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..set">.set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.valueFor">valueFor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580enums">⬇︎⠀enums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580name">⬇︎⠀name</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580value">⬇︎⠀value</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580values">⬇︎⠀values</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#GenerateEnumsProxyHandler">GenerateEnumsProxyHandler</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.clearCache">clearCache</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.%25E2%258C%25BE%25E2%25A0%2580generateSchemaSDL">⌾⠀generateSchemaSDL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#astMiddleware">astMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#schemaMiddleware">schemaMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%258C%25BE%25E2%25A0%2580customMiddleware">⌾⠀customMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middleware">⬇︎⠀middleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middlewareWithoutGraphiQL">⬇︎⠀middlewareWithoutGraphiQL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580schema">⬇︎⠀schema</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLInterface.html">GQLInterface</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLInterface.html#.%25E2%258C%25BE%25E2%25A0%2580resolveType">⌾⠀resolveType</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLScalar.html">GQLScalar</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseLiteral">parseLiteral</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseValue">parseValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.serialize">serialize</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.html">IDLFileHandler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getFile">⌾⠀getFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSchema">⌾⠀getSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSyntaxTree">⌾⠀getSyntaxTree</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.html">ModuleParser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580arrayToPattern">⌾⠀arrayToPattern</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580checkForPackageExtensions">⌾⠀checkForPackageExtensions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580findGQLBaseClasses">⌾⠀findGQLBaseClasses</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580importClass">⌾⠀importClass</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parse">⌾⠀parse</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parseSync">⌾⠀parseSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walk">⌾⠀walk</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walkSync">⌾⠀walkSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SchemaUtils.html">SchemaUtils</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580createMergedRoot">⌾⠀createMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectComments">⌾⠀injectComments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectEnums">⌾⠀injectEnums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectInterfaceResolvers">⌾⠀injectInterfaceResolvers</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectScalars">⌾⠀injectScalars</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SyntaxTree.html">SyntaxTree</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyDocument">⌾⠀EmptyDocument</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyMutation">⌾⠀EmptyMutation</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyQuery">⌾⠀EmptyQuery</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findDefinition">⌾⠀findDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findField">⌾⠀findField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findInASTArrayByNameValue">⌾⠀findInASTArrayByNameValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580from">⌾⠀from</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromAST">⌾⠀fromAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromSchema">⌾⠀fromSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580appendDefinitions">⌾⠀appendDefinitions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580consumeDefinition">⌾⠀consumeDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580find">⌾⠀find</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580findEnumDefinition">⌾⠀findEnumDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580setAST">⌾⠀setAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580toString">⌾⠀toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580updateAST">⌾⠀updateAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580ast">⬆︎⠀ast</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580ast">⬇︎⠀ast</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="utils.Deferred.html">Deferred</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="decorators.html">decorators</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#.%25E2%258C%25BE%25E2%25A0%2580extractBits">⌾⠀extractBits</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580AdjacentSchema">.🏷⠀AdjacentSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580FileSchema">.🏷⠀FileSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Getters">.🏷⠀Getters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Properties">.🏷⠀Properties</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Schema">.🏷⠀Schema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Setters">.🏷⠀Setters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#~decorate">decorate</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="GQLBaseEnv.html">GQLBaseEnv</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBaseEnv.html#~notDefined">notDefined</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#applyTags">applyTags</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#AsyncFunctionExecutionError">AsyncFunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_API_DOCS">CHECK_API_DOCS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_RESOLVERS">CHECK_RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_SCHEMA">CHECK_SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECKLIST">CHECKLIST</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#FunctionExecutionError">FunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getChecklist">getChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#hasChecklist">hasChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#newChecklist">newChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setChecklist">setChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#types">types</a></span></li>
28</nav>
29
30<div id="main">
  
  <h1 class="page-title">decorators/ModelProperties.js</h1>
  
34
  
36
37
38
  
  <section>
      <article>
          <pre class="prettyprint source linenums"><code>/** @namespace decorators */
43
44import {
GQLBase, MODEL_KEY, META_KEY, GETTERS, SETTERS, PROPS, AUTO_PROPS
46} from '../GQLBase'
47import { isArray, extendsFrom } from 'ne-types'
48import { inspect } from 'util'
49import { GraphQLEnumType, parse } from 'graphql'
50import { SyntaxTree } from '../SyntaxTree'
51
52/**
* For each of the decorators, Getters, Setters, and Properties, we take a
* list of property names used to create the appropriate accessor types. In
* some cases, however, the instance of GQLBase's data model may have a
* different name. Finally if the return type for the getter should be wrapped
* in a another GQLBase class type, we will need a way to specify those things
* too.
*
* The `extractBits()` takes a single argument value from the decorator as it
* parses them and converts it into an object, properly sorted, into values that
* allow the above described behavior.
*
* Examples:
*
* ```
* // Create a class with a name and age property that map directly to the
* // underlying data model
* @Getters('name', 'age')
* class MyType extends GQLBase {...}
*
* // Create a class with a name property that maps to a different property
* // name in the underlying data model
* @Getters(['name', '_fake_name'])
* class MyMockType extends GQLBase {...}
*
* // Create a class with an employee property that returns an Employee
* @Getters(['employee', Employee])
* class MyRoleType extends GQLBase {...}
*
* // Finally create a class with an employe property that returns an Employee
* // with data under a different name in the underlying data model.
* @Getters(['employee', '_worker', Employee])
* class MyMockRoleType extends GQLBase {...}
* ```
*
* @memberof decorators
* @method ⌾⠀extractBits
* @since 2.5
*
* @param {String|Array&lt;String|Function>} property name of a property, or list
* of property names and a Class.
* @return {Object} an object with the following format ```
* {
*   fieldName: name of root instance property to create
*   modelName: name of its associated internal model property
*   typeClass: an optional class to wrap around the results in a getter
* }
* ```
*/
101function extractBits(property) {
let array = isArray(property) ? property : [property, property, null]
let reply;
104
if (!property) {
  let error = new Error(
    'Invalid property. Given\n  %o',
    inspect(property, {depth: 2})
  );
110
  return {
    fieldName: 'anErrorOccurred',
    modelName: 'anErrorOccurred',
    typeClass: null,
    getterMaker: function() { return () => error },
    setterMaker: function() { return (v) => undefined }
  }
}
119
//
if (array.length === 3) {
  reply = {
    fieldName: array[0],
    modelName: array[1],
    typeClass: typeof array[2] === 'function' &amp;&amp; array[2] || null
  }
}
128
//
else if (array.length === 2) {
  reply = {
    fieldName: array[0],
    modelName: typeof array[1] === 'string'
      ? array[1]
      : array[0],
    typeClass: typeof array[1] === 'function' &amp;&amp; array[1] || null
  }
}
139
//
else {
  reply = {
    fieldName: array[0],
    modelName: array[0],
    typeClass: array[0]
  }
}
148
reply.getterMaker = function() {
  let { modelName, fieldName, typeClass } = reply;
151
  return function() {
    const thisClass = this.constructor
    const model = this[MODEL_KEY] || null
    let val
156
    if (!extendsFrom(thisClass, GQLBase)) {
      console.error(`${thisClass.name} is not derived from GQLBase`);
      return undefined
    }
161
    if (!thisClass.SCHEMA) {
      throw new Error(`
      All GQLBase extended classes should have a defined SCHEMA. Please
      manually define a static get SCHEMA() in your class or use the
      @Schema() decorator to do so.
      `)
    }
169
    if (typeClass) {
      // If the value of the model is already the type of class we expect
      // we do not need to do any processing and we can just grab it and
      // go.
      if (model[modelName] &amp;&amp; extendsFrom(model[modelName], typeClass)) {
        val = model[modelName]
      }
177
      // Otherwise we need to return an instance of the determined typeClass
      // and pass that back instead; as requested.
      else {
        const results = SyntaxTree.findField(
          parse(this.constructor.SCHEMA),
          this.constructor.name,
          modelName
        )
        const { meta } = results || { meta: null };
187
        let args = [model[modelName], this.requestData];
189
        if (meta &amp;&amp; !meta.nullable &amp;&amp; !model) {
          throw new Error(`
            Using @Getters or @Properties decorators with a null or
            undefined model when the schema states that this field
            cannot be null.
195
            Type      : ${typeClass.name}
            Field (AST data)
              name    : ${meta.name}
              type    : ${meta.type}
              nullable: ${meta.nullable}
            [getter]  : ${fieldName}
            [maps to] : ${modelName}
            [model  ] : ${model}
          `)
        }
206
        // If the following is true, it means that despite allowing nulls
        // for this field in the schema, we do have a valid model and should
        // proceed.
        if (model) {
          if (extractBits.DIRECT_TYPES.includes(typeClass.name)) {
            val = typeClass(...args)
          }
          else {
            val = new typeClass(...args)
          }
217
          if (typeClass.GQL_TYPE === GraphQLEnumType) { return val.value; }
        }
      }
    }
    else {
      val = model[modelName];
    }
225
    if (val === 'undefined' || val === undefined) {
      val = null;
    }
229
    return val;
  }
}
233
reply.setterMaker = function() {
  let { modelName } = reply;
  return function (value) {
    this[MODEL_KEY][modelName] = value;
  }
}
240
return reply;
242}
243
244/**
* An array of proper class names that are used to test for cases where the
* proper usage of instantiating an instance should preclude the use of `new`
*
* @memberof decorators
* @type {Array&lt;String>}
*/
251extractBits.DIRECT_TYPES = [
String.name
253];
254
255/**
* A small suite of functions a getter that allows easy manipulation of the
* the DIRECT_TYPES workaround needed for some types of complex class
* wrapping allowed by the @Getters and @Properties decorators. Namely the
* ability to do something like @Getters('name', String) which would wrap the
* contents of whatever is in the objects model in a String call.
*
* Direct types are those that need to be called without `new` in order for the
* desired behavior to present itself.
*
* @memberof decorators
* @type {Object}
* @since 2.7.0
*/
269export const DirectTypeManager = {
/**
 * A getter that retrieves the array of direct types
 *
 * @method DirectTypeManager#types
 * @member {Array&lt;String>} types
 *
 * @return {Array&lt;String>} an array of class name strings.
 */
get types(): Array&lt;String> {
  return extractBits.DIRECT_TYPES
},
281
/**
 * Appends the supplied class name to the list of registered direct types. If
 * a class or function is passed, rather than a String,
 *
 * @method DirectTypeManager#types
 *
 * @param {Function|string|RegExp} className the name of the class to append.
 * Typically it is best to pass the name property of the class in question
 * such as `RegExp.name` or `MyClass.name`.
 */
add(className: string | RegExp | Function): void {
  if (typeof className === 'function') {
    className = className.name
  }
296
  extractBits.DIRECT_TYPES.push(className);
},
299
/**
 * Foricbly empties the contents of the extractBits.DIRECT_TYPES array. This
 * is not recommended as it can have unintended consequences. It is
 * recommended to use `reset` instead
 *
 * @method DirectTypeManager#clear
 *
 * @return {Array&lt;string>} an array of class name Strings that were removed
 * when cleared.
 */
clear(): Array&lt;string> {
  return extractBits.DIRECT_TYPES.splice(0, extractBits.DIRECT_TYPES.length)
},
313
/**
 * The recommended way to reset the DIRECT_TYPES list. This removes all
 * changed values, returns the removed bits, and adds back in the defaults.
 *
 * @method DirectTypeManager#reset
 *
 * @return {Array&lt;string>} an array of class name Strings that were removed
 * during the reset process.
 */
reset(): Array&lt;string> {
  return extractBits.DIRECT_TYPES.splice(
    0,
    extractBits.DIRECT_TYPES.length,
    String.name
  )
}
330}
331
332/**
* This decorator allows you to add a Class method to the DirectTypeManager
* as a function that should not be invoked with the `new` keyword. For all
* intents and purposes the function should be declared `static`.
*
* @method DirectTypeAdd
* @param {Function} target [description]
* @constructor
*/
341export function DirectTypeAdd(target) {
DirectTypeManager.add(target);
return target;
344}
345
346/**
* When applying multiple property getters and setters, knowing some info
* about what was applied elsewhere can be important. "Tags" can be applied
* that store the fieldName and descriptor applied via one of these decorators.
*
* Multiple "tags" are supported to allow for detecting the difference between
* decorators applied by the developer using lattice and something auto
* generated such as auto-props.
*
* @param  {GQLBase} Class an instance of GQLBase to apply the tags tp
* @param  {Array&lt;string|Symbol>} addTags an array of Symbols or strings to be
* wrapped in Symbols that will be used as tag keys
* @param  {string} fieldName the name of the field being decorated
* @param  {Object} descriptor the JavaScript descriptor object to associate
* with this tagged field.
*/
362export function applyTags(
Class:GQLBase,
addTags: Array&lt;string|Symbol>,
fieldName: string,
descriptor: Object
367) {
let tags = (Array.isArray(addTags) &amp;&amp; addTags || [])
  .map(tag => typeof tag === 'string' &amp;&amp; Symbol.for(tag) || tag)
  .filter(tag => typeof tag === 'symbol')
371
tags.forEach(tag => {
  Class[META_KEY][tag] = Class[META_KEY][tag] || {}
  Class[META_KEY][tag][fieldName] = descriptor
})
376}
377
378/**
* When working with `GQLBase` instances that expose properties
* that have a 1:1 mapping to their own model property of the
* same name, adding the getters manually can be annoying. This
* takes an indeterminate amount of strings representing the
* properties for which getters should be injected.
*
* @function 🏷⠀Getters
* @memberof! decorators
*
* @param {Array&lt;String|Array&lt;String>>} propertyNames if the model has 'name'
* and 'age' as properties, then passing those two strings will result
* in getters that surface those properties as GraphQL fields.
* @return {Function} a class decorator method.s
*/
393export function Getters(
...propertyNames: Array&lt;String|Array&lt;String|Function>>
395): Function {
return function(target: mixed, addTags: Array&lt;string|Symbol> = []): mixed {
  for (let property of propertyNames) {
    let { fieldName, getterMaker } = extractBits(property);
    let desc = Object.getOwnPropertyDescriptor(target.prototype, fieldName)
    let hasImpl = desc &amp;&amp; (desc.get || typeof desc.value === 'function')
    let tags = [GETTERS].concat(Array.isArray(addTags) &amp;&amp; addTags || [])
402
    if (!hasImpl) {
      let descriptor = {
        get: getterMaker()
      }
407
      applyTags(target, tags, fieldName, descriptor)
      Object.defineProperty(target.prototype, fieldName, descriptor);
    }
    else {
      console.warn(
        `Skipping getter for ${target.name}.${fieldName}; already exists`
      )
    }
  }
417
  return target;
}
420}
421
422/**
* When working with `GQLBase` instances that expose properties
* that have a 1:1 mapping to their own model property of the
* same name, adding the setters manually can be annoying. This
* takes an indeterminate amount of strings representing the
* properties for which setters should be injected.
*
* @function 🏷⠀Setters
* @memberof! decorators
* @since 2.1.0
*
* @param {Array&lt;String|Array&lt;String>>} propertyNames if the model has
* 'name' and 'age' as properties, then passing those two strings will
* result in setters that surface those properties as GraphQL fields.
* @return {Function} a class decorator method
*/
438export function Setters(
...propertyNames: Array&lt;String|Array&lt;String|Function>>
440): Function {
return function(target: mixed, addTags: Array&lt;String|Symbol> = []): mixed {
  for (let property of propertyNames) {
    let { fieldName, setterMaker } = extractBits(property);
    let desc = Object.getOwnPropertyDescriptor(target.prototype, fieldName)
    let hasImpl = desc &amp;&amp; (desc.get || typeof desc.value === 'function')
    let tags = [SETTERS].concat(Array.isArray(addTags) &amp;&amp; addTags || [])
447
    if (!hasImpl) {
      let descriptor = {
        set: setterMaker()
      }
452
      applyTags(target, tags, fieldName, descriptor)
      Object.defineProperty(target.prototype, fieldName, descriptor);
    }
    else {
      console.warn(
        `Skipping setter for ${target.name}.${fieldName}; already exists`
      )
    }
  }
462
  return target;
}
465}
466
467/**
* When working with `GQLBase` instances that expose properties
* that have a 1:1 mapping to their own model property of the
* same name, adding the getters manually can be annoying. This
* takes an indeterminate amount of strings representing the
* properties for which getters should be injected.
*
* This method creates both getters and setters
*
* @function 🏷⠀Properties
* @memberof! decorators
* @since 2.1.0
*
* @param {Array&lt;String|Array&lt;String>>} propertyNames if the model has 'name'
* and 'age' as properties, then passing those two strings will result
* in getters and setters that surface those properties as GraphQL fields.
* @return {Function} a class decorator method
*/
485export function Properties(
...propertyNames: Array&lt;String|Array&lt;String|Function>>
487): Function {
return function(target: mixed, addTags: Array&lt;String|Symbol> = []): mixed {
  for (let property of propertyNames) {
    let {fieldName, getterMaker, setterMaker } = extractBits(property);
    let desc = Object.getOwnPropertyDescriptor(target.prototype, fieldName)
    let hasImpl = desc &amp;&amp; (desc.get || typeof desc.value === 'function')
    let tags = [PROPS].concat(Array.isArray(addTags) &amp;&amp; addTags || [])
494
    if (!hasImpl) {
      let descriptor = {
        set: setterMaker(),
        get: getterMaker()
      }
500
      applyTags(target, tags, fieldName, descriptor)
      Object.defineProperty(target.prototype, fieldName, descriptor);
    }
    else {
      console.warn(
        `Skipping properties for ${target.name}.${fieldName}; already exists`
      )
    }
  }
510
  return target;
}
513}
514
515export default Properties;
516</code></pre>
      </article>
  </section>
519
520
521
522
523</div>
524
525<br class="clear">
526
527<footer>
  Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jun 08 2018 19:28:39 GMT-0700 (PDT) using the Minami theme.
529</footer>
530
531<script>prettyPrint();</script>
532<script src="scripts/linenumber.js"></script>
533</body>
534</html>