| 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>GQLExpressMiddleware - Documentation</title>
|
| 7 |
|
| 8 | <script src="scripts/prettify/prettify.js"></script>
|
| 9 | <script src="scripts/prettify/lang-css.js"></script>
|
| 10 | |
| 11 | |
| 12 |
|
| 13 | <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
| 14 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
| 15 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
| 16 | </head>
|
| 17 | <body>
|
| 18 |
|
| 19 | <input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
| 20 | <label for="nav-trigger" class="navicon-button x">
|
| 21 | <div class="navicon"></div>
|
| 22 | </label>
|
| 23 |
|
| 24 | <label for="nav-trigger" class="overlay"></label>
|
| 25 |
|
| 26 | <nav>
|
| 27 | <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580asyncFn">⌾⠀asyncFn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580setPromise">⌾⠀setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html#setPromise">setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Deferred_exports.Deferred.html">Deferred</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DirectTypeAdd.html">DirectTypeAdd</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="FunctionExecutionError_FunctionExecutionError.html">FunctionExecutionError</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.html">GQLBase</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.apiDocs">apiDocs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getMergedRoot">⌾⠀getMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580IDLFilePath">⌾⠀IDLFilePath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580MUTATORS">⌾⠀MUTATORS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580RESOLVERS">⌾⠀RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580setupModel">⌾⠀setupModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580handler">⬇︎⠀handler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580SCHEMA">⬇︎⠀SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580applyAutoProps">⌾⠀applyAutoProps</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580callProp">⌾⠀callProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580extendModel">⌾⠀extendModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getModel">⌾⠀getModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580setModel">⌾⠀setModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580requestData">⬆︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580requestData">⬇︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~deleteProperty">deleteProperty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~set">set</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLEnum.html">GQLEnum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..get">.get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..set">.set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.valueFor">valueFor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580enums">⬇︎⠀enums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580name">⬇︎⠀name</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580value">⬇︎⠀value</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580values">⬇︎⠀values</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#GenerateEnumsProxyHandler">GenerateEnumsProxyHandler</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.clearCache">clearCache</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.%25E2%258C%25BE%25E2%25A0%2580generateSchemaSDL">⌾⠀generateSchemaSDL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#astMiddleware">astMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#schemaMiddleware">schemaMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%258C%25BE%25E2%25A0%2580customMiddleware">⌾⠀customMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middleware">⬇︎⠀middleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middlewareWithoutGraphiQL">⬇︎⠀middlewareWithoutGraphiQL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580schema">⬇︎⠀schema</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLInterface.html">GQLInterface</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLInterface.html#.%25E2%258C%25BE%25E2%25A0%2580resolveType">⌾⠀resolveType</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLScalar.html">GQLScalar</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseLiteral">parseLiteral</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseValue">parseValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.serialize">serialize</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.html">IDLFileHandler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getFile">⌾⠀getFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSchema">⌾⠀getSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSyntaxTree">⌾⠀getSyntaxTree</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.html">ModuleParser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580arrayToPattern">⌾⠀arrayToPattern</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580checkForPackageExtensions">⌾⠀checkForPackageExtensions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580findGQLBaseClasses">⌾⠀findGQLBaseClasses</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580importClass">⌾⠀importClass</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parse">⌾⠀parse</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parseSync">⌾⠀parseSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walk">⌾⠀walk</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walkSync">⌾⠀walkSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SchemaUtils.html">SchemaUtils</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580createMergedRoot">⌾⠀createMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectComments">⌾⠀injectComments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectEnums">⌾⠀injectEnums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectInterfaceResolvers">⌾⠀injectInterfaceResolvers</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectScalars">⌾⠀injectScalars</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SyntaxTree.html">SyntaxTree</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyDocument">⌾⠀EmptyDocument</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyMutation">⌾⠀EmptyMutation</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyQuery">⌾⠀EmptyQuery</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findDefinition">⌾⠀findDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findField">⌾⠀findField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findInASTArrayByNameValue">⌾⠀findInASTArrayByNameValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580from">⌾⠀from</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromAST">⌾⠀fromAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromSchema">⌾⠀fromSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580appendDefinitions">⌾⠀appendDefinitions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580consumeDefinition">⌾⠀consumeDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580find">⌾⠀find</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580findEnumDefinition">⌾⠀findEnumDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580setAST">⌾⠀setAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580toString">⌾⠀toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580updateAST">⌾⠀updateAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580ast">⬆︎⠀ast</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580ast">⬇︎⠀ast</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="utils.Deferred.html">Deferred</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="decorators.html">decorators</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#.%25E2%258C%25BE%25E2%25A0%2580extractBits">⌾⠀extractBits</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580AdjacentSchema">.🏷⠀AdjacentSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580FileSchema">.🏷⠀FileSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Getters">.🏷⠀Getters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Properties">.🏷⠀Properties</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Schema">.🏷⠀Schema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Setters">.🏷⠀Setters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#~decorate">decorate</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="GQLBaseEnv.html">GQLBaseEnv</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBaseEnv.html#~notDefined">notDefined</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#applyTags">applyTags</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#AsyncFunctionExecutionError">AsyncFunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_API_DOCS">CHECK_API_DOCS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_RESOLVERS">CHECK_RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_SCHEMA">CHECK_SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECKLIST">CHECKLIST</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#FunctionExecutionError">FunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getChecklist">getChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#hasChecklist">hasChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#newChecklist">newChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setChecklist">setChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#types">types</a></span></li>
|
| 28 | </nav>
|
| 29 |
|
| 30 | <div id="main">
|
| 31 |
|
| 32 | <h1 class="page-title">GQLExpressMiddleware</h1>
|
| 33 |
|
| 34 |
|
| 35 |
|
| 36 |
|
| 37 |
|
| 38 |
|
| 39 |
|
| 40 | <section>
|
| 41 |
|
| 42 | <header>
|
| 43 |
|
| 44 | <h2>
|
| 45 | GQLExpressMiddleware
|
| 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="GQLExpressMiddleware"><span class="type-signature"></span>new GQLExpressMiddleware<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 | <div class="description">
|
| 66 | <p>A handler that exposes an express middleware function that mounts a<br>GraphQL I/O endpoint. Typical usage follows:</p>
|
| 67 | <pre class="prettyprint source lang-js"><code>const app = express();
|
| 68 | app.use(/.../, new GQLExpressMiddleware([...classes]).middleware);</code></pre>
|
| 69 | </div>
|
| 70 |
|
| 71 |
|
| 72 |
|
| 73 |
|
| 74 |
|
| 75 | <dl class="details">
|
| 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 |
|
| 102 | <dt class="tag-source">Source:</dt>
|
| 103 | <dd class="tag-source"><ul class="dummy"><li>
|
| 104 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line28">line 28</a>
|
| 105 | </li></ul></dd>
|
| 106 |
|
| 107 |
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 | </dl>
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 |
|
| 130 |
|
| 131 |
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 |
|
| 136 |
|
| 137 | </div>
|
| 138 |
|
| 139 | </div>
|
| 140 |
|
| 141 |
|
| 142 |
|
| 143 |
|
| 144 |
|
| 145 |
|
| 146 | <h3 class="subsection-title">Classes</h3>
|
| 147 |
|
| 148 | <dl>
|
| 149 | <dt><a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></dt>
|
| 150 | <dd></dd>
|
| 151 | </dl>
|
| 152 |
|
| 153 |
|
| 154 |
|
| 155 |
|
| 156 |
|
| 157 |
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 | <h3 class="subsection-title">Methods</h3>
|
| 162 |
|
| 163 |
|
| 164 |
|
| 165 | <div class="section-method">
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 | <h4 class="name" id=".clearCache"><span class="type-signature">(static) </span>clearCache<span class="signature">()</span><span class="type-signature"> → {<a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a>}</span></h4>
|
| 170 |
|
| 171 |
|
| 172 |
|
| 173 |
|
| 174 |
|
| 175 | <div class="description">
|
| 176 | <p>The Schema String and Schema AST/GraphQLSchema JavaScript objects are<br>cached after being processed once. If there is a runtime need to rebuild<br>these objects, calling <code>clearCache()</code> will allow their next usage to<br>rebuild them dynamically.</p>
|
| 177 | </div>
|
| 178 |
|
| 179 |
|
| 180 |
|
| 181 |
|
| 182 |
|
| 183 | <dl class="details">
|
| 184 |
|
| 185 |
|
| 186 |
|
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
|
| 191 |
|
| 192 |
|
| 193 |
|
| 194 |
|
| 195 |
|
| 196 |
|
| 197 |
|
| 198 |
|
| 199 |
|
| 200 |
|
| 201 |
|
| 202 |
|
| 203 |
|
| 204 |
|
| 205 |
|
| 206 |
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 | <dt class="tag-source">Source:</dt>
|
| 211 | <dd class="tag-source"><ul class="dummy"><li>
|
| 212 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line67">line 67</a>
|
| 213 | </li></ul></dd>
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
|
| 221 | </dl>
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 | <div class="section-returns">
|
| 244 | <h5>Returns:</h5>
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 | <dl class="param-type">
|
| 249 | <dt>
|
| 250 | Type:
|
| 251 | </dt>
|
| 252 | <dd>
|
| 253 |
|
| 254 | <span class="param-type"><code><a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></code></span>
|
| 255 |
|
| 256 |
|
| 257 | </dd>
|
| 258 | </dl>
|
| 259 |
|
| 260 |
|
| 261 | <div class="param-desc">
|
| 262 | <p>returns this so that it can be inlined; ala<br><code>gqlExpressMiddleware.clearCache().ast</code>, for example</p>
|
| 263 | </div>
|
| 264 |
|
| 265 |
|
| 266 | </div>
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 | </div>
|
| 271 |
|
| 272 |
|
| 273 | <div class="section-method">
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 | <h4 class="name" id=".%E2%8C%BE%E2%A0%80generateSchemaSDL"><span class="type-signature">(static) </span>⌾⠀generateSchemaSDL<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
|
| 278 |
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 |
|
| 283 | <div class="description">
|
| 284 | <p>A function that combines the IDL schemas of all the supplied classes and<br>returns that value to the middleware getter.</p>
|
| 285 | </div>
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 | <dl class="details">
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 |
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 | <dt class="tag-source">Source:</dt>
|
| 319 | <dd class="tag-source"><ul class="dummy"><li>
|
| 320 | <a href="SchemaUtils.js.html">SchemaUtils.js</a>, <a href="SchemaUtils.js.html#line223">line 223</a>
|
| 321 | </li></ul></dd>
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 | </dl>
|
| 330 |
|
| 331 |
|
| 332 |
|
| 333 |
|
| 334 |
|
| 335 |
|
| 336 |
|
| 337 |
|
| 338 |
|
| 339 |
|
| 340 |
|
| 341 |
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 |
|
| 346 |
|
| 347 |
|
| 348 |
|
| 349 |
|
| 350 |
|
| 351 | <div class="section-returns">
|
| 352 | <h5>Returns:</h5>
|
| 353 |
|
| 354 |
|
| 355 |
|
| 356 | <dl class="param-type">
|
| 357 | <dt>
|
| 358 | Type:
|
| 359 | </dt>
|
| 360 | <dd>
|
| 361 |
|
| 362 | <span class="param-type"><code>string</code></span>
|
| 363 |
|
| 364 |
|
| 365 | </dd>
|
| 366 | </dl>
|
| 367 |
|
| 368 |
|
| 369 | <div class="param-desc">
|
| 370 | <p>a dynamically generated GraphQL IDL schema string</p>
|
| 371 | </div>
|
| 372 |
|
| 373 |
|
| 374 | </div>
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 | </div>
|
| 379 |
|
| 380 |
|
| 381 | <div class="section-method">
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 | <h4 class="name" id="astMiddleware"><span class="type-signature"></span>astMiddleware<span class="signature">()</span><span class="type-signature"> → {function}</span></h4>
|
| 386 |
|
| 387 |
|
| 388 |
|
| 389 |
|
| 390 |
|
| 391 | <div class="description">
|
| 392 | <p>An optional express middleware function that can be mounted to return<br>the JSON AST representation of the schema string being used by<br>GQLExpressMiddleware.</p>
|
| 393 | </div>
|
| 394 |
|
| 395 |
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 | <dl class="details">
|
| 400 |
|
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
|
| 406 |
|
| 407 |
|
| 408 |
|
| 409 |
|
| 410 |
|
| 411 |
|
| 412 |
|
| 413 |
|
| 414 |
|
| 415 |
|
| 416 |
|
| 417 |
|
| 418 |
|
| 419 |
|
| 420 |
|
| 421 |
|
| 422 |
|
| 423 |
|
| 424 |
|
| 425 |
|
| 426 | <dt class="tag-source">Source:</dt>
|
| 427 | <dd class="tag-source"><ul class="dummy"><li>
|
| 428 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line355">line 355</a>
|
| 429 | </li></ul></dd>
|
| 430 |
|
| 431 |
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 |
|
| 436 |
|
| 437 | </dl>
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
|
| 445 |
|
| 446 |
|
| 447 |
|
| 448 |
|
| 449 |
|
| 450 |
|
| 451 |
|
| 452 |
|
| 453 |
|
| 454 |
|
| 455 |
|
| 456 |
|
| 457 |
|
| 458 |
|
| 459 | <div class="section-returns">
|
| 460 | <h5>Returns:</h5>
|
| 461 |
|
| 462 |
|
| 463 |
|
| 464 | <dl class="param-type">
|
| 465 | <dt>
|
| 466 | Type:
|
| 467 | </dt>
|
| 468 | <dd>
|
| 469 |
|
| 470 | <span class="param-type"><code>function</code></span>
|
| 471 |
|
| 472 |
|
| 473 | </dd>
|
| 474 | </dl>
|
| 475 |
|
| 476 |
|
| 477 |
|
| 478 | </div>
|
| 479 |
|
| 480 |
|
| 481 |
|
| 482 | </div>
|
| 483 |
|
| 484 |
|
| 485 | <div class="section-method">
|
| 486 |
|
| 487 |
|
| 488 |
|
| 489 | <h4 class="name" id="schemaMiddleware"><span class="type-signature"></span>schemaMiddleware<span class="signature">()</span><span class="type-signature"> → {function}</span></h4>
|
| 490 |
|
| 491 |
|
| 492 |
|
| 493 |
|
| 494 |
|
| 495 | <div class="description">
|
| 496 | <p>An optional express middleware function that can be mounted to return<br>a copy of the generated schema string being used by GQLExpressMiddleware.</p>
|
| 497 | </div>
|
| 498 |
|
| 499 |
|
| 500 |
|
| 501 |
|
| 502 |
|
| 503 | <dl class="details">
|
| 504 |
|
| 505 |
|
| 506 |
|
| 507 |
|
| 508 |
|
| 509 |
|
| 510 |
|
| 511 |
|
| 512 |
|
| 513 |
|
| 514 |
|
| 515 |
|
| 516 |
|
| 517 |
|
| 518 |
|
| 519 |
|
| 520 |
|
| 521 |
|
| 522 |
|
| 523 |
|
| 524 |
|
| 525 |
|
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 | <dt class="tag-source">Source:</dt>
|
| 531 | <dd class="tag-source"><ul class="dummy"><li>
|
| 532 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line339">line 339</a>
|
| 533 | </li></ul></dd>
|
| 534 |
|
| 535 |
|
| 536 |
|
| 537 |
|
| 538 |
|
| 539 |
|
| 540 |
|
| 541 | </dl>
|
| 542 |
|
| 543 |
|
| 544 |
|
| 545 |
|
| 546 |
|
| 547 |
|
| 548 |
|
| 549 |
|
| 550 |
|
| 551 |
|
| 552 |
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
|
| 557 |
|
| 558 |
|
| 559 |
|
| 560 |
|
| 561 |
|
| 562 |
|
| 563 | <div class="section-returns">
|
| 564 | <h5>Returns:</h5>
|
| 565 |
|
| 566 |
|
| 567 |
|
| 568 | <dl class="param-type">
|
| 569 | <dt>
|
| 570 | Type:
|
| 571 | </dt>
|
| 572 | <dd>
|
| 573 |
|
| 574 | <span class="param-type"><code>function</code></span>
|
| 575 |
|
| 576 |
|
| 577 | </dd>
|
| 578 | </dl>
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 | </div>
|
| 583 |
|
| 584 |
|
| 585 |
|
| 586 | </div>
|
| 587 |
|
| 588 |
|
| 589 | <div class="section-method">
|
| 590 |
|
| 591 |
|
| 592 |
|
| 593 | <h4 class="name" id="%E2%8C%BE%E2%A0%80customMiddleware"><span class="type-signature"></span>⌾⠀customMiddleware<span class="signature">(graphqlHttpOptions<span class="signature-attributes">opt</span>, patchFn)</span><span class="type-signature"> → {function}</span></h4>
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 | <div class="description">
|
| 600 | <p>If your needs require you to specify different values to <code>graphqlHTTP</code>,<br>part of the <code>express-graphql</code> package, you can use the <code>customMiddleware</code><br>function to do so.</p>
|
| 601 | <p>The first parameter is an object that should contain valid <code>graphqlHTTP</code><br>options. See https://github.com/graphql/express-graphql#options for more<br>details. Validation is NOT performed.</p>
|
| 602 | <p>The second parameter is a function that will be called after any options<br>have been applied from the first parameter and the rest of the middleware<br>has been performed. This, if not modified, will be the final options<br>passed into <code>graphqlHTTP</code>. In your callback, it is expected that the<br>supplied object is to be modified and THEN RETURNED. Whatever is returned<br>will be used or passed on. If nothing is returned, the options supplied<br>to the function will be used instead.</p>
|
| 603 | </div>
|
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 | <dl class="details">
|
| 610 |
|
| 611 |
|
| 612 |
|
| 613 |
|
| 614 |
|
| 615 |
|
| 616 |
|
| 617 |
|
| 618 |
|
| 619 |
|
| 620 |
|
| 621 |
|
| 622 |
|
| 623 |
|
| 624 |
|
| 625 |
|
| 626 |
|
| 627 |
|
| 628 |
|
| 629 |
|
| 630 |
|
| 631 |
|
| 632 |
|
| 633 |
|
| 634 |
|
| 635 |
|
| 636 | <dt class="tag-source">Source:</dt>
|
| 637 | <dd class="tag-source"><ul class="dummy"><li>
|
| 638 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line321">line 321</a>
|
| 639 | </li></ul></dd>
|
| 640 |
|
| 641 |
|
| 642 |
|
| 643 |
|
| 644 |
|
| 645 |
|
| 646 |
|
| 647 | </dl>
|
| 648 |
|
| 649 |
|
| 650 |
|
| 651 |
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 |
|
| 656 |
|
| 657 | <h5>Parameters:</h5>
|
| 658 |
|
| 659 |
|
| 660 | <table class="params">
|
| 661 | <thead>
|
| 662 | <tr>
|
| 663 |
|
| 664 | <th>Name</th>
|
| 665 |
|
| 666 |
|
| 667 | <th>Type</th>
|
| 668 |
|
| 669 |
|
| 670 | <th>Attributes</th>
|
| 671 |
|
| 672 |
|
| 673 |
|
| 674 | <th>Default</th>
|
| 675 |
|
| 676 |
|
| 677 | <th class="last">Description</th>
|
| 678 | </tr>
|
| 679 | </thead>
|
| 680 |
|
| 681 | <tbody>
|
| 682 |
|
| 683 |
|
| 684 | <tr>
|
| 685 |
|
| 686 | <td class="name"><code>graphqlHttpOptions</code></td>
|
| 687 |
|
| 688 |
|
| 689 | <td class="type">
|
| 690 |
|
| 691 |
|
| 692 | <span class="param-type"><code>Object</code></span>
|
| 693 |
|
| 694 |
|
| 695 |
|
| 696 | </td>
|
| 697 |
|
| 698 |
|
| 699 | <td class="attributes">
|
| 700 |
|
| 701 | <optional><br>
|
| 702 |
|
| 703 |
|
| 704 |
|
| 705 |
|
| 706 |
|
| 707 | </td>
|
| 708 |
|
| 709 |
|
| 710 |
|
| 711 | <td class="default">
|
| 712 |
|
| 713 | {graphiql: true}
|
| 714 |
|
| 715 | </td>
|
| 716 |
|
| 717 |
|
| 718 | <td class="description last">
|
| 719 | <p>standard set of<br><code>express-graphql</code> options. See above.</p>
|
| 720 |
|
| 721 | </td>
|
| 722 | </tr>
|
| 723 |
|
| 724 |
|
| 725 |
|
| 726 | <tr>
|
| 727 |
|
| 728 | <td class="name"><code>patchFn</code></td>
|
| 729 |
|
| 730 |
|
| 731 | <td class="type">
|
| 732 |
|
| 733 |
|
| 734 | <span class="param-type"><code>function</code></span>
|
| 735 |
|
| 736 |
|
| 737 |
|
| 738 | </td>
|
| 739 |
|
| 740 |
|
| 741 | <td class="attributes">
|
| 742 |
|
| 743 |
|
| 744 |
|
| 745 |
|
| 746 |
|
| 747 | </td>
|
| 748 |
|
| 749 |
|
| 750 |
|
| 751 | <td class="default">
|
| 752 |
|
| 753 | </td>
|
| 754 |
|
| 755 |
|
| 756 | <td class="description last">
|
| 757 | <p>see above</p>
|
| 758 |
|
| 759 | </td>
|
| 760 | </tr>
|
| 761 |
|
| 762 |
|
| 763 | </tbody>
|
| 764 | </table>
|
| 765 |
|
| 766 |
|
| 767 |
|
| 768 |
|
| 769 |
|
| 770 |
|
| 771 |
|
| 772 |
|
| 773 |
|
| 774 |
|
| 775 |
|
| 776 |
|
| 777 |
|
| 778 |
|
| 779 | <div class="section-returns">
|
| 780 | <h5>Returns:</h5>
|
| 781 |
|
| 782 |
|
| 783 |
|
| 784 | <dl class="param-type">
|
| 785 | <dt>
|
| 786 | Type:
|
| 787 | </dt>
|
| 788 | <dd>
|
| 789 |
|
| 790 | <span class="param-type"><code>function</code></span>
|
| 791 |
|
| 792 |
|
| 793 | </dd>
|
| 794 | </dl>
|
| 795 |
|
| 796 |
|
| 797 | <div class="param-desc">
|
| 798 | <p>a middleware function compatible with Express</p>
|
| 799 | </div>
|
| 800 |
|
| 801 |
|
| 802 | </div>
|
| 803 |
|
| 804 |
|
| 805 |
|
| 806 | </div>
|
| 807 |
|
| 808 |
|
| 809 | <div class="section-method">
|
| 810 |
|
| 811 |
|
| 812 |
|
| 813 | <h4 class="name" id="%E2%AC%87%EF%B8%8E%E2%A0%80middleware"><span class="type-signature"></span>⬇︎⠀middleware<span class="signature">()</span><span class="type-signature"> → {function}</span></h4>
|
| 814 |
|
| 815 |
|
| 816 |
|
| 817 |
|
| 818 |
|
| 819 | <div class="description">
|
| 820 | <p>Using the express-graphql module, it returns an Express 4.x middleware<br>function.</p>
|
| 821 | </div>
|
| 822 |
|
| 823 |
|
| 824 |
|
| 825 |
|
| 826 |
|
| 827 | <dl class="details">
|
| 828 |
|
| 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 | <dt class="tag-source">Source:</dt>
|
| 855 | <dd class="tag-source"><ul class="dummy"><li>
|
| 856 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line139">line 139</a>
|
| 857 | </li></ul></dd>
|
| 858 |
|
| 859 |
|
| 860 |
|
| 861 |
|
| 862 |
|
| 863 |
|
| 864 |
|
| 865 | </dl>
|
| 866 |
|
| 867 |
|
| 868 |
|
| 869 |
|
| 870 |
|
| 871 |
|
| 872 |
|
| 873 |
|
| 874 |
|
| 875 |
|
| 876 |
|
| 877 |
|
| 878 |
|
| 879 |
|
| 880 |
|
| 881 |
|
| 882 |
|
| 883 |
|
| 884 |
|
| 885 |
|
| 886 |
|
| 887 | <div class="section-returns">
|
| 888 | <h5>Returns:</h5>
|
| 889 |
|
| 890 |
|
| 891 |
|
| 892 | <dl class="param-type">
|
| 893 | <dt>
|
| 894 | Type:
|
| 895 | </dt>
|
| 896 | <dd>
|
| 897 |
|
| 898 | <span class="param-type"><code>function</code></span>
|
| 899 |
|
| 900 |
|
| 901 | </dd>
|
| 902 | </dl>
|
| 903 |
|
| 904 |
|
| 905 | <div class="param-desc">
|
| 906 | <p>a function that expects request, response and next<br>parameters as all Express middleware functions.</p>
|
| 907 | </div>
|
| 908 |
|
| 909 |
|
| 910 | </div>
|
| 911 |
|
| 912 |
|
| 913 |
|
| 914 | </div>
|
| 915 |
|
| 916 |
|
| 917 | <div class="section-method">
|
| 918 |
|
| 919 |
|
| 920 |
|
| 921 | <h4 class="name" id="%E2%AC%87%EF%B8%8E%E2%A0%80middlewareWithoutGraphiQL"><span class="type-signature"></span>⬇︎⠀middlewareWithoutGraphiQL<span class="signature">()</span><span class="type-signature"> → {function}</span></h4>
|
| 922 |
|
| 923 |
|
| 924 |
|
| 925 |
|
| 926 |
|
| 927 | <div class="description">
|
| 928 | <p>Using the express-graphql module, it returns an Express 4.x middleware<br>function. This version however, has graphiql disabled. Otherwise it is<br>identical to the <code>middleware</code> property</p>
|
| 929 | </div>
|
| 930 |
|
| 931 |
|
| 932 |
|
| 933 |
|
| 934 |
|
| 935 | <dl class="details">
|
| 936 |
|
| 937 |
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 |
|
| 942 |
|
| 943 |
|
| 944 |
|
| 945 |
|
| 946 |
|
| 947 |
|
| 948 |
|
| 949 |
|
| 950 |
|
| 951 |
|
| 952 |
|
| 953 |
|
| 954 |
|
| 955 |
|
| 956 |
|
| 957 |
|
| 958 |
|
| 959 |
|
| 960 |
|
| 961 |
|
| 962 | <dt class="tag-source">Source:</dt>
|
| 963 | <dd class="tag-source"><ul class="dummy"><li>
|
| 964 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line154">line 154</a>
|
| 965 | </li></ul></dd>
|
| 966 |
|
| 967 |
|
| 968 |
|
| 969 |
|
| 970 |
|
| 971 |
|
| 972 |
|
| 973 | </dl>
|
| 974 |
|
| 975 |
|
| 976 |
|
| 977 |
|
| 978 |
|
| 979 |
|
| 980 |
|
| 981 |
|
| 982 |
|
| 983 |
|
| 984 |
|
| 985 |
|
| 986 |
|
| 987 |
|
| 988 |
|
| 989 |
|
| 990 |
|
| 991 |
|
| 992 |
|
| 993 |
|
| 994 |
|
| 995 | <div class="section-returns">
|
| 996 | <h5>Returns:</h5>
|
| 997 |
|
| 998 |
|
| 999 |
|
| 1000 | <dl class="param-type">
|
| 1001 | <dt>
|
| 1002 | Type:
|
| 1003 | </dt>
|
| 1004 | <dd>
|
| 1005 |
|
| 1006 | <span class="param-type"><code>function</code></span>
|
| 1007 |
|
| 1008 |
|
| 1009 | </dd>
|
| 1010 | </dl>
|
| 1011 |
|
| 1012 |
|
| 1013 | <div class="param-desc">
|
| 1014 | <p>a function that expects request, response and next<br>parameters as all Express middleware functions.</p>
|
| 1015 | </div>
|
| 1016 |
|
| 1017 |
|
| 1018 | </div>
|
| 1019 |
|
| 1020 |
|
| 1021 |
|
| 1022 | </div>
|
| 1023 |
|
| 1024 |
|
| 1025 | <div class="section-method">
|
| 1026 |
|
| 1027 |
|
| 1028 |
|
| 1029 | <h4 class="name" id="%E2%AC%87%EF%B8%8E%E2%A0%80schema"><span class="type-signature"></span>⬇︎⠀schema<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
|
| 1030 |
|
| 1031 |
|
| 1032 |
|
| 1033 |
|
| 1034 |
|
| 1035 | <div class="description">
|
| 1036 | <p>Generates the textual schema based on the registered <code>GQLBase</code> handlers<br>this instance represents.</p>
|
| 1037 | </div>
|
| 1038 |
|
| 1039 |
|
| 1040 |
|
| 1041 |
|
| 1042 |
|
| 1043 | <dl class="details">
|
| 1044 |
|
| 1045 |
|
| 1046 |
|
| 1047 |
|
| 1048 | <dt class="tag-since">Since:</dt>
|
| 1049 | <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
|
| 1050 |
|
| 1051 |
|
| 1052 |
|
| 1053 |
|
| 1054 |
|
| 1055 |
|
| 1056 |
|
| 1057 |
|
| 1058 |
|
| 1059 |
|
| 1060 |
|
| 1061 |
|
| 1062 |
|
| 1063 |
|
| 1064 |
|
| 1065 |
|
| 1066 |
|
| 1067 |
|
| 1068 |
|
| 1069 |
|
| 1070 |
|
| 1071 |
|
| 1072 |
|
| 1073 | <dt class="tag-source">Source:</dt>
|
| 1074 | <dd class="tag-source"><ul class="dummy"><li>
|
| 1075 | <a href="GQLExpressMiddleware.js.html">GQLExpressMiddleware.js</a>, <a href="GQLExpressMiddleware.js.html#line106">line 106</a>
|
| 1076 | </li></ul></dd>
|
| 1077 |
|
| 1078 |
|
| 1079 |
|
| 1080 |
|
| 1081 |
|
| 1082 |
|
| 1083 |
|
| 1084 | </dl>
|
| 1085 |
|
| 1086 |
|
| 1087 |
|
| 1088 |
|
| 1089 |
|
| 1090 |
|
| 1091 |
|
| 1092 |
|
| 1093 |
|
| 1094 |
|
| 1095 |
|
| 1096 |
|
| 1097 |
|
| 1098 |
|
| 1099 |
|
| 1100 |
|
| 1101 |
|
| 1102 |
|
| 1103 |
|
| 1104 |
|
| 1105 |
|
| 1106 | <div class="section-returns">
|
| 1107 | <h5>Returns:</h5>
|
| 1108 |
|
| 1109 |
|
| 1110 |
|
| 1111 | <dl class="param-type">
|
| 1112 | <dt>
|
| 1113 | Type:
|
| 1114 | </dt>
|
| 1115 | <dd>
|
| 1116 |
|
| 1117 | <span class="param-type"><code>string</code></span>
|
| 1118 |
|
| 1119 |
|
| 1120 | </dd>
|
| 1121 | </dl>
|
| 1122 |
|
| 1123 |
|
| 1124 | <div class="param-desc">
|
| 1125 | <p>a generated schema string based on the handlers that<br>are registered with this <code>GQLExpressMiddleware</code> instance.</p>
|
| 1126 | </div>
|
| 1127 |
|
| 1128 |
|
| 1129 | </div>
|
| 1130 |
|
| 1131 |
|
| 1132 |
|
| 1133 | </div>
|
| 1134 |
|
| 1135 |
|
| 1136 |
|
| 1137 |
|
| 1138 |
|
| 1139 |
|
| 1140 | </article>
|
| 1141 |
|
| 1142 | </section>
|
| 1143 |
|
| 1144 |
|
| 1145 |
|
| 1146 |
|
| 1147 | </div>
|
| 1148 |
|
| 1149 | <br class="clear">
|
| 1150 |
|
| 1151 | <footer>
|
| 1152 | 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.
|
| 1153 | </footer>
|
| 1154 |
|
| 1155 | <script>prettyPrint();</script>
|
| 1156 | <script src="scripts/linenumber.js"></script>
|
| 1157 | </body>
|
| 1158 | </html> |
| \ | No newline at end of file |