UNPKG

graphql-lattice/docs/GQLExpressMiddleware.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>GQLExpressMiddleware.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">GQLExpressMiddleware.js</h1>
  
34
  
36
37
38
  
  <section>
      <article>
          <pre class="prettyprint source linenums"><code>// @flow
43// @module GQLExpressMiddleware
44
45import { SyntaxTree } from './SyntaxTree'
46import { GQLBase } from './GQLBase'
47import { GQLInterface } from './GQLInterface'
48import { GQLScalar } from './GQLScalar'
49import { typeOf } from 'ne-types'
50import { SchemaUtils } from './SchemaUtils'
51import _, { merge } from 'lodash'
52import { makeExecutableSchema } from 'graphql-tools'
53
54import {
parse,
print,
buildSchema,
GraphQLSchema,
GraphQLInterfaceType,
GraphQLEnumType,
GraphQLScalarType
62} from 'graphql'
63
64import bodyParser from 'body-parser'
65import graphqlHTTP from 'express-graphql'
66import EventEmitter from 'events'
67import path from 'path'
68
69/**
* A handler that exposes an express middleware function that mounts a
* GraphQL I/O endpoint. Typical usage follows:
*
* ```js
* const app = express();
* app.use(/.../, new GQLExpressMiddleware([...classes]).middleware);
* ```
*
* @class GQLExpressMiddleware
*/
80export class GQLExpressMiddleware extends EventEmitter
81{
handlers: Array&lt;GQLBase>;
83
schema: string;
85
cache: Map&lt;any, any> = new Map()
87
/**
 * For now, takes an Array of classes extending from GQLBase. These are
 * parsed and a combined schema of all their individual schemas is generated
 * via the use of ASTs. This is passed off to express-graphql.
 *
 * @memberof GQLExpressMiddleware
 * @method ⎆⠀constructor
 * @constructor
 *
 * @param {Array&lt;GQLBase>} handlers an array of GQLBase extended classes
 */
constructor(handlers: Array&lt;GQLBase>) {
  super()
101
  this.handlers = handlers
103
  // Generate and cache the schema SDL/IDL string and ast obj (GraphQLSchema)
  this.ast
}
107
/**
 * The Schema String and Schema AST/GraphQLSchema JavaScript objects are
 * cached after being processed once. If there is a runtime need to rebuild
 * these objects, calling `clearCache()` will allow their next usage to
 * rebuild them dynamically.
 *
 * @method clearCache
 * @memberof GQLExpressMiddleware
 *
 * @return {GQLExpressMiddleware} returns this so that it can be inlined; ala
 * `gqlExpressMiddleware.clearCache().ast`, for example
 */
clearCache(): GQLExpressMiddleware {
  this.cache.clear()
  return this
}
124
/**
 * The schema property returns the textual Schema as it is generated based
 * on the various Lattice types, interfaces and enums defined in your
 * project. The ast property returns the JavaScript AST represenatation of
 * that schema with all injected modificiations detailed in your classes.
 */
get ast(): GraphQLSchema {
  let cached: ?GraphQLSchema = this.cache.get('ast')
133
  if (cached) {
    return cached
  }
137
  let ast: GraphQLSchema = buildSchema(this.schema)
139
  SchemaUtils.injectAll(ast, this.handlers);
141
  this.cache.set('ast', ast)
143
  return ast;
}
146
/**
 * Generates the textual schema based on the registered `GQLBase` handlers
 * this instance represents.
 *
 * @method GQLExpressMiddleware#⬇︎⠀schema
 * @since 2.7.0
 *
 * @return {string} a generated schema string based on the handlers that
 * are registered with this `GQLExpressMiddleware` instance.
 */
get schema(): string {
  let cached = this.cache.get('schema')
  let schema
160
  if (cached) return cached
162
  schema = SchemaUtils.generateSchemaSDL(this.handlers);
  this.cache.set('schema', schema)
165
  return schema
}
168
async rootValue(
  requestData: Object,
  separateByType: boolean = false
): Object {
  let root = await SchemaUtils.createMergedRoot(
    this.handlers, requestData, separateByType
  )
176
  return root;
}
179
/**
 * Using the express-graphql module, it returns an Express 4.x middleware
 * function.
 *
 * @instance
 * @memberof GQLExpressMiddleware
 * @method ⬇︎⠀middleware
 *
 * @return {Function} a function that expects request, response and next
 * parameters as all Express middleware functions.
 */
get middleware(): Function {
  return this.customMiddleware();
}
194
/**
 * Using the express-graphql module, it returns an Express 4.x middleware
 * function. This version however, has graphiql disabled. Otherwise it is
 * identical to the `middleware` property
 *
 * @instance
 * @memberof GQLExpressMiddleware
 * @method ⬇︎⠀middlewareWithoutGraphiQL
 *
 * @return {Function} a function that expects request, response and next
 * parameters as all Express middleware functions.
 */
get middlewareWithoutGraphiQL(): Function {
  return this.customMiddleware({graphiql: false});
}
210
/**
 * In order to ensure that Lattice functions receive the request data,
 * it is important to use the options function feature of both
 * `express-graphql` and `apollo-server-express`. This function will create
 * an options function that reflects that schema and Lattice types defined
 * in your project.
 *
 * Should you need to tailor the response before it is sent out, you may
 * supply a function as a second parameter that takes two parameters and
 * returns an options object. The patchFn callback signature looks like this
 *
 * ```patchFn(options, {req, res, next|gql})```
 *
 * When using the reference implementation, additional graphql request info
 * can be obtained in lieu of the `next()` function so typically found in
 * Express middleware. Apollo Server simply provides the next function in
 * this location.
 *
 * @param {Object} options any options, to either engine, that make the most
 * sense
 * @param {Function} patchFn see above
 */
generateOptions(
  options: Object = { graphiql: true },
  patchFn: ?Function = null
): Function {
  const optsFn = async (req: mixed, res: mixed, gql: mixed) => {
    let schema = this.ast;
    let opts = {
      schema,
      rootValue: await this.rootValue({req, res, gql}),
      formatError: error => ({
        message: error.message,
        locations: error.locations,
        stack: error.stack,
        path: error.path
      })
    }
249
    merge(opts, options);
    if (patchFn &amp;&amp; typeof patchFn === 'function') {
      merge(
        opts,
        (patchFn.bind(this)(opts, {req, res, gql})) || opts
      );
    }
257
    return opts;
  }
260
  return optsFn
}
263
  /**
 * In order to ensure that Lattice functions receive the request data,
 * it is important to use the options function feature of both
 * `express-graphql` and `apollo-server-express`. This function will create
 * an options function that reflects that schema and Lattice types defined
 * in your project.
 *
 * Should you need to tailor the response before it is sent out, you may
 * supply a function as a second parameter that takes two parameters and
 * returns an options object. The patchFn callback signature looks like this
 *
 * ```patchFn(options, {req, res, next|gql})```
 *
 * When using the reference implementation, additional graphql request info
 * can be obtained in lieu of the `next()` function so typically found in
 * Express middleware. Apollo Server simply provides the next function in
 * this location.
 *
 * @param {Object} options any options, to either engine, that make the most
 * sense
 * @param {Function} patchFn see above
 */
generateApolloOptions(
  options: Object = {
    formatError: error => ({
      message: error.message,
      locations: error.locations,
      stack: error.stack,
      path: error.path
    }),
    debug: true
  },
  patchFn: ?Function = null
): Function {
  const optsFn = async (req: mixed, res: mixed) => {
    let opts = {
      schema: this.ast,
      resolvers: await this.rootValue({req, res}, true)
    }
303
    opts.schema = makeExecutableSchema({
      typeDefs: [this.schema],
      resolvers: opts.resolvers
    })
308
    SchemaUtils.injectAll(opts.schema, this.handlers);
310
    merge(opts, options);
    if (patchFn &amp;&amp; typeof patchFn === 'function') {
      merge(
        opts,
        (patchFn.bind(this)(opts, {req, res})) || opts
      );
    }
318
    return opts;
  }
321
  return optsFn
}
324
apolloMiddleware(
  apolloFn: Function,
  apolloOpts: Object = {},
  patchFn: ?Function = null
): Array&lt;Function> {
  let opts = this.generateApolloOptions(apolloOpts, patchFn)
331
  return [
    bodyParser.json(),
    bodyParser.text({ type: 'application/graphql' }),
    (req, res, next) => {
        if (req.is('application/graphql')) {
            req.body = { query: req.body };
        }
        next();
    },
    apolloFn(opts)
  ]
}
344
/**
 * If your needs require you to specify different values to `graphqlHTTP`,
 * part of the `express-graphql` package, you can use the `customMiddleware`
 * function to do so.
 *
 * The first parameter is an object that should contain valid `graphqlHTTP`
 * options. See https://github.com/graphql/express-graphql#options for more
 * details. Validation is NOT performed.
 *
 * The second parameter is a function that will be called after any options
 * have been applied from the first parameter and the rest of the middleware
 * has been performed. This, if not modified, will be the final options
 * passed into `graphqlHTTP`. In your callback, it is expected that the
 * supplied object is to be modified and THEN RETURNED. Whatever is returned
 * will be used or passed on. If nothing is returned, the options supplied
 * to the function will be used instead.
 *
 * @method ⌾⠀customMiddleware
 * @memberof GQLExpressMiddleware
 * @instance
 *
 * @param {Object} [graphqlHttpOptions={graphiql: true}] standard set of
 * `express-graphql` options. See above.
 * @param {Function} patchFn see above
369
 * @return {Function} a middleware function compatible with Express
 */
customMiddleware(
  graphqlHttpOptions: Object = {graphiql: true},
  patchFn?: Function
): Function {
  const optsFn = this.generateOptions(graphqlHttpOptions, patchFn)
  return graphqlHTTP(optsFn)
}
379
/**
 * An optional express middleware function that can be mounted to return
 * a copy of the generated schema string being used by GQLExpressMiddleware.
 *
 * @memberof GQLExpressMiddleware
 * @method schemaMiddleware
 * @instance
 *
 * @type {Function}
 */
get schemaMiddleware(): Function {
  return (req: Object, res: Object, next: ?Function) => {
    res.status(200).send(this.schema);
  }
}
395
/**
 * An optional express middleware function that can be mounted to return
 * the JSON AST representation of the schema string being used by
 * GQLExpressMiddleware.
 *
 * @memberof GQLExpressMiddleware
 * @method astMiddleware
 * @instance
 *
 * @type {Function}
 */
get astMiddleware(): Function {
  return (req: Object, res: Object, next: ?Function) => {
    res.status(200).send('Temporarily disabled in this version')
410
    // let cachedOutput = this.cache.get('astMiddlewareOutput')
    // if (cachedOutput) {
    //   res
    //     .status(302)
    //     .set('Content-Type', 'application/json')
    //     .send(cachedOutput)
    // }
    // else {
    //   this.rootValue({req, res, next}, true)
    //     .then(resolvers => {
    //       let schema: GraphQLSchema = buildSchema(this.schema)
422
    //       SchemaUtils.injectInterfaceResolvers(schema, this.handlers);
    //       SchemaUtils.injectEnums(schema, this.handlers);
    //       SchemaUtils.injectScalars(schema, this.handlers);
    //       SchemaUtils.injectComments(schema, this.handlers);
427
    //       function killToJSON(obj: any, path = 'obj.') {
    //         for (let key in obj) {
    //           try {
    //             if (key == 'prev' || key == 'next' || key == 'ofType') continue;
432
    //             if (key == 'toJSON') {
    //               let success = delete obj.toJSON
    //               //console.log(`Killing ${path}toJSON...${success ? 'success' : 'failure'}`)
    //               continue
    //             }
438
    //             if (key == 'inspect') {
    //               let success = delete obj.inspect
    //               //console.log(`Killing ${path}inspect...${success ? 'success' : 'failure'}`)
    //               continue
    //             }
444
    //             if (key == 'toString') {
    //               obj.toString = Object.prototype.toString
    //               //console.log(`Replacing ${path}toString with default`)
    //               continue
    //             }
450
    //             if (typeof obj[key] == 'function') {
    //               obj[key] = `[Function ${obj[key].name}]`
    //               continue
    //             }
455
    //             if (typeof obj[key] == 'object') {
    //               obj[key] = killToJSON(obj[key], `${path}${key}.`)
    //               continue
    //             }
    //           }
    //           catch (error) {
    //             continue
    //           }
    //         }
465
    //         return obj
    //       }
468
    //       // $FlowFixMe
    //       schema = killToJSON(schema)
471
    //       // Still do not know why/how they are preventing JSONifying the
    //       // _typeMap keys. So aggravting
    //       for (let typeKey of Object.keys(schema._typeMap)) {
    //         let object = {}
476
    //         // $FlowFixMe
    //         for (let valKey of Object.keys(schema._typeMap[typeKey])) {
    //           // $FlowFixMe
    //           object[valKey] = schema._typeMap[typeKey][valKey]
    //         }
482
    //         // $FlowFixMe
    //         schema._typeMap[typeKey] = object
    //       }
486
    //       let output = JSON.stringify(schema)
    //       this.cache.delete('ast')
    //       this.cache.set('astMiddlewareOutput', output)
490
    //       res
    //         .status(200)
    //         .set('Content-Type', 'application/json')
    //         .send(output)
    //     })
    //     .catch(error => {
    //       console.error(error)
498
    //       res
    //         .status(500)
    //         .json(error)
    //     })
    // }
  }
}
506}
507
508export default GQLExpressMiddleware;
509</code></pre>
      </article>
  </section>
512
513
514
515
516</div>
517
518<br class="clear">
519
520<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.
522</footer>
523
524<script>prettyPrint();</script>
525<script src="scripts/linenumber.js"></script>
526</body>
527</html>