UNPKG

46.1 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <meta name="viewport" content="width=device-width,initial-scale=1">
6 <title>ModuleParser - Documentation</title>
7
8 <script src="scripts/prettify/prettify.js"></script>
9 <script src="scripts/prettify/lang-css.js"></script>
10 <!--[if lt IE 9]>
11 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12 <![endif]-->
13 <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
14 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16</head>
17<body>
18
19<input type="checkbox" id="nav-trigger" class="nav-trigger" />
20<label for="nav-trigger" class="navicon-button x">
21 <div class="navicon"></div>
22</label>
23
24<label for="nav-trigger" class="overlay"></label>
25
26<nav>
27 <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580asyncFn">⌾⠀asyncFn</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580setPromise">⌾⠀setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html">AwaitingPromiseError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="AwaitingPromiseError_exports.AwaitingPromiseError.html#setPromise">setPromise</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Deferred_exports.Deferred.html">Deferred</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DirectTypeAdd.html">DirectTypeAdd</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="FunctionExecutionError_FunctionExecutionError.html">FunctionExecutionError</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.html">GQLBase</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.apiDocs">apiDocs</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getMergedRoot">⌾⠀getMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580IDLFilePath">⌾⠀IDLFilePath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580MUTATORS">⌾⠀MUTATORS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580RESOLVERS">⌾⠀RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580setupModel">⌾⠀setupModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580handler">⬇︎⠀handler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580SCHEMA">⬇︎⠀SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580applyAutoProps">⌾⠀applyAutoProps</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580callProp">⌾⠀callProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580extendModel">⌾⠀extendModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getModel">⌾⠀getModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580setModel">⌾⠀setModel</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580requestData">⬆︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580requestData">⬇︎⠀requestData</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~deleteProperty">deleteProperty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBase.html#~set">set</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLEnum.html">GQLEnum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..get">.get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#..set">.set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.valueFor">valueFor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580enums">⬇︎⠀enums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580name">⬇︎⠀name</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580value">⬇︎⠀value</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580values">⬇︎⠀values</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLEnum.html#GenerateEnumsProxyHandler">GenerateEnumsProxyHandler</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.clearCache">clearCache</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#.%25E2%258C%25BE%25E2%25A0%2580generateSchemaSDL">⌾⠀generateSchemaSDL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#astMiddleware">astMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#schemaMiddleware">schemaMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%258C%25BE%25E2%25A0%2580customMiddleware">⌾⠀customMiddleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middleware">⬇︎⠀middleware</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middlewareWithoutGraphiQL">⬇︎⠀middlewareWithoutGraphiQL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580schema">⬇︎⠀schema</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLInterface.html">GQLInterface</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLInterface.html#.%25E2%258C%25BE%25E2%25A0%2580resolveType">⌾⠀resolveType</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="GQLScalar.html">GQLScalar</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseLiteral">parseLiteral</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.parseValue">parseValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLScalar.html#.serialize">serialize</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.html">IDLFileHandler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getFile">⌾⠀getFile</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSchema">⌾⠀getSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSyntaxTree">⌾⠀getSyntaxTree</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="IDLFileHandler.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.html">ModuleParser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580arrayToPattern">⌾⠀arrayToPattern</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580checkForPackageExtensions">⌾⠀checkForPackageExtensions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580findGQLBaseClasses">⌾⠀findGQLBaseClasses</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580importClass">⌾⠀importClass</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parse">⌾⠀parse</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parseSync">⌾⠀parseSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walk">⌾⠀walk</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walkSync">⌾⠀walkSync</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="ModuleParser.html#~%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SchemaUtils.html">SchemaUtils</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580createMergedRoot">⌾⠀createMergedRoot</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectComments">⌾⠀injectComments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectEnums">⌾⠀injectEnums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectInterfaceResolvers">⌾⠀injectInterfaceResolvers</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectScalars">⌾⠀injectScalars</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="SyntaxTree.html">SyntaxTree</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyDocument">⌾⠀EmptyDocument</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyMutation">⌾⠀EmptyMutation</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyQuery">⌾⠀EmptyQuery</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findDefinition">⌾⠀findDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findField">⌾⠀findField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findInASTArrayByNameValue">⌾⠀findInASTArrayByNameValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580from">⌾⠀from</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromAST">⌾⠀fromAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromSchema">⌾⠀fromSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#.%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580appendDefinitions">⌾⠀appendDefinitions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580consumeDefinition">⌾⠀consumeDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580find">⌾⠀find</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580findEnumDefinition">⌾⠀findEnumDefinition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580setAST">⌾⠀setAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580toString">⌾⠀toString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580updateAST">⌾⠀updateAST</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580ast">⬆︎⠀ast</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="SyntaxTree.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580ast">⬇︎⠀ast</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="utils.Deferred.html">Deferred</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="decorators.html">decorators</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#.%25E2%258C%25BE%25E2%25A0%2580extractBits">⌾⠀extractBits</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580AdjacentSchema">.🏷⠀AdjacentSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580FileSchema">.🏷⠀FileSchema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Getters">.🏷⠀Getters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Properties">.🏷⠀Properties</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Schema">.🏷⠀Schema</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Setters">.🏷⠀Setters</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="decorators.html#~decorate">decorate</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="GQLBaseEnv.html">GQLBaseEnv</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="GQLBaseEnv.html#~notDefined">notDefined</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#applyTags">applyTags</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#AsyncFunctionExecutionError">AsyncFunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_API_DOCS">CHECK_API_DOCS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_RESOLVERS">CHECK_RESOLVERS</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECK_SCHEMA">CHECK_SCHEMA</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#CHECKLIST">CHECKLIST</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#FunctionExecutionError">FunctionExecutionError</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getChecklist">getChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#hasChecklist">hasChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#newChecklist">newChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#setChecklist">setChecklist</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#types">types</a></span></li>
28</nav>
29
30<div id="main">
31
32 <h1 class="page-title">ModuleParser</h1>
33
34
35
36
37
38
39
40<section>
41
42<header>
43
44 <h2>
45 ModuleParser
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="ModuleParser"><span class="type-signature"></span>new ModuleParser<span class="signature">()</span><span class="type-signature"></span></h4>
60
61
62
63
64
65<div class="description">
66 <p>The ModuleParser is a utility class designed to loop through and iterate<br>on a directory and pull out of each .js file found, any classes or exports<br>that extend from GQLBase or a child of GQLBase.</p>
67</div>
68
69
70
71
72
73<dl class="details">
74
75
76
77
78 <dt class="tag-since">Since:</dt>
79 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103 <dt class="tag-source">Source:</dt>
104 <dd class="tag-source"><ul class="dummy"><li>
105 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line31">line 31</a>
106 </li></ul></dd>
107
108
109
110
111
112
113
114</dl>
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138</div>
139
140 </div>
141
142
143
144
145
146
147 <h3 class="subsection-title">Classes</h3>
148
149 <dl>
150 <dt><a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></dt>
151 <dd></dd>
152 </dl>
153
154
155
156
157
158
159
160
161
162 <h3 class="subsection-title">Methods</h3>
163
164
165
166<div class="section-method">
167
168
169
170 <h4 class="name" id=".%E2%8C%BE%E2%A0%80arrayToPattern"><span class="type-signature">(static) </span>⌾⠀arrayToPattern<span class="signature">(extensions, flags)</span><span class="type-signature"> &rarr; {RegExp}</span></h4>
171
172
173
174
175
176<div class="description">
177 <p>The ModuleParser should only parse files that match the default or<br>supplied file extensions. The default list contains .js, .jsx, .ts<br>and .tsx; so JavaScript or TypeScript files and their JSX React<br>counterparts</p>
178<p>Since the list is customizable for a usage, however, it makes sense<br>to have a function that will match what is supplied rather than<br>creating a constant expression to use instead.</p>
179</div>
180
181
182
183
184
185<dl class="details">
186
187
188
189
190 <dt class="tag-since">Since:</dt>
191 <dd class="tag-since"><ul class="dummy"><li>2.13.0</li></ul></dd>
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215 <dt class="tag-source">Source:</dt>
216 <dd class="tag-source"><ul class="dummy"><li>
217 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line453">line 453</a>
218 </li></ul></dd>
219
220
221
222
223
224
225
226</dl>
227
228
229
230
231
232
233
234
235
236 <h5>Parameters:</h5>
237
238
239<table class="params">
240 <thead>
241 <tr>
242
243 <th>Name</th>
244
245
246 <th>Type</th>
247
248
249
250
251
252 <th class="last">Description</th>
253 </tr>
254 </thead>
255
256 <tbody>
257
258
259 <tr>
260
261 <td class="name"><code>extensions</code></td>
262
263
264 <td class="type">
265
266
267<span class="param-type"><code>Array.&lt;string></code></span>
268
269
270
271 </td>
272
273
274
275
276
277 <td class="description last">
278 <p>an array of extensions to<br>convert to a regular expression that would pass for each</p>
279
280 </td>
281 </tr>
282
283
284
285 <tr>
286
287 <td class="name"><code>flags</code></td>
288
289
290 <td class="type">
291
292
293<span class="param-type"><code>string</code></span>
294
295
296
297 </td>
298
299
300
301
302
303 <td class="description last">
304 <p>the value passed to a new RegExp denoting the<br>flags used in the pattern; defaults to 'i' for case insensitivity</p>
305
306 </td>
307 </tr>
308
309
310 </tbody>
311</table>
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326<div class="section-returns">
327<h5>Returns:</h5>
328
329
330
331<dl class="param-type">
332 <dt>
333 Type:
334 </dt>
335 <dd>
336
337<span class="param-type"><code>RegExp</code></span>
338
339
340 </dd>
341</dl>
342
343
344<div class="param-desc">
345 <p>a regular expression object matching the contents<br>of the array of extensions or the default extensions and that will<br>also match those values in a case insensitive manner</p>
346</div>
347
348
349</div>
350
351
352
353</div>
354
355
356<div class="section-method">
357
358
359
360 <h4 class="name" id=".%E2%8C%BE%E2%A0%80checkForPackageExtensions"><span class="type-signature">(static) </span>⌾⠀checkForPackageExtensions<span class="signature">(toString)</span><span class="type-signature"> &rarr; (nullable) {Array.&lt;string>}</span></h4>
361
362
363
364
365
366<div class="description">
367 <p>Using the module <code>read-pkg-up</code>, finds the nearest package.json file<br>and checks to see if it has a <code>.lattice.moduleParser.extensions'
368preference. If so, if the value is an array, that value is used,
369otherwise the value is wrapped in an array. If the optional parameter</code>toString<code>is</code>true<code>then</code>.toString()` will be invoked on any non<br>Array values found; this behavior is the default</p>
370</div>
371
372
373
374
375
376<dl class="details">
377
378
379
380
381 <dt class="tag-since">Since:</dt>
382 <dd class="tag-since"><ul class="dummy"><li>2.13.0</li></ul></dd>
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406 <dt class="tag-source">Source:</dt>
407 <dd class="tag-source"><ul class="dummy"><li>
408 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line489">line 489</a>
409 </li></ul></dd>
410
411
412
413
414
415
416
417</dl>
418
419
420
421
422
423
424
425
426
427 <h5>Parameters:</h5>
428
429
430<table class="params">
431 <thead>
432 <tr>
433
434 <th>Name</th>
435
436
437 <th>Type</th>
438
439
440
441
442
443 <th class="last">Description</th>
444 </tr>
445 </thead>
446
447 <tbody>
448
449
450 <tr>
451
452 <td class="name"><code>toString</code></td>
453
454
455 <td class="type">
456
457
458<span class="param-type"><code>boolean</code></span>
459
460
461
462 </td>
463
464
465
466
467
468 <td class="description last">
469 <p>true if any non-array values should have<br>their <code>.toString()</code> method invoked before being wrapped in an Array;<br>defaults to true</p>
470
471 </td>
472 </tr>
473
474
475 </tbody>
476</table>
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491<div class="section-returns">
492<h5>Returns:</h5>
493
494
495
496<dl class="param-type">
497 <dt>
498 Type:
499 </dt>
500 <dd>
501
502<span class="param-type"><code>Array.&lt;string></code></span>
503
504
505 </dd>
506</dl>
507
508
509<div class="param-desc">
510 <p>null if no value is set for the property<br><code>lattice.ModuleParser.extensions</code> in <code>package.json</code> or the value<br>of the setting if it is an array. Finally if the value is set but is<br>not an array, the specified value wrapped in an array is returned</p>
511</div>
512
513
514</div>
515
516
517
518</div>
519
520
521<div class="section-method">
522
523
524
525 <h4 class="name" id="%E2%8C%BE%E2%A0%80findGQLBaseClasses"><span class="type-signature"></span>⌾⠀findGQLBaseClasses<span class="signature">(contents, gqlDefinitions)</span><span class="type-signature"> &rarr; {Set.&lt;mixed>}</span></h4>
526
527
528
529
530
531<div class="description">
532 <p>Given an object, typically the result of a <code>require()</code> or <code>import</code><br>command, iterate over its contents and find any <code>GQLBase</code> derived<br>exports. Continually, and recursively, build this list of classes out<br>so that we can add them to a <code>GQLExpressMiddleware</code>.</p>
533</div>
534
535
536
537
538
539<dl class="details">
540
541
542
543
544 <dt class="tag-since">Since:</dt>
545 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569 <dt class="tag-source">Source:</dt>
570 <dd class="tag-source"><ul class="dummy"><li>
571 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line153">line 153</a>
572 </li></ul></dd>
573
574
575
576
577
578
579
580</dl>
581
582
583
584
585
586
587
588
589
590 <h5>Parameters:</h5>
591
592
593<table class="params">
594 <thead>
595 <tr>
596
597 <th>Name</th>
598
599
600 <th>Type</th>
601
602
603
604
605
606 <th class="last">Description</th>
607 </tr>
608 </thead>
609
610 <tbody>
611
612
613 <tr>
614
615 <td class="name"><code>contents</code></td>
616
617
618 <td class="type">
619
620
621<span class="param-type"><code>Object</code></span>
622
623
624
625 </td>
626
627
628
629
630
631 <td class="description last">
632 <p>the object to parse for properties extending<br>from <code>GQLBase</code></p>
633
634 </td>
635 </tr>
636
637
638
639 <tr>
640
641 <td class="name"><code>gqlDefinitions</code></td>
642
643
644 <td class="type">
645
646
647<span class="param-type"><code>Array.&lt;<a href="GQLBase.html">GQLBase</a>></code></span>
648
649
650
651 </td>
652
653
654
655
656
657 <td class="description last">
658 <p>the results, allowed as a second<br>parameter during recursion as a means to save state between calls</p>
659
660 </td>
661 </tr>
662
663
664 </tbody>
665</table>
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680<div class="section-returns">
681<h5>Returns:</h5>
682
683
684
685<dl class="param-type">
686 <dt>
687 Type:
688 </dt>
689 <dd>
690
691<span class="param-type"><code>Set.&lt;mixed></code></span>
692
693
694 </dd>
695</dl>
696
697
698<div class="param-desc">
699 <p>a unique set of values that are currently being<br>iterated over. Passed in as a third parameter to save state between calls<br>during recursion.</p>
700</div>
701
702
703</div>
704
705
706
707</div>
708
709
710<div class="section-method">
711
712
713
714 <h4 class="name" id="%E2%8C%BE%E2%A0%80importClass"><span class="type-signature"></span>⌾⠀importClass<span class="signature">(filePath)</span><span class="type-signature"> &rarr; {Object}</span></h4>
715
716
717
718
719
720<div class="description">
721 <p>Given a file path, this method will attempt to import/require the<br>file in question and return the object it exported; whatever that<br>may be.</p>
722</div>
723
724
725
726
727
728<dl class="details">
729
730
731
732
733 <dt class="tag-since">Since:</dt>
734 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758 <dt class="tag-source">Source:</dt>
759 <dd class="tag-source"><ul class="dummy"><li>
760 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line116">line 116</a>
761 </li></ul></dd>
762
763
764
765
766
767
768
769</dl>
770
771
772
773
774
775
776
777
778
779 <h5>Parameters:</h5>
780
781
782<table class="params">
783 <thead>
784 <tr>
785
786 <th>Name</th>
787
788
789 <th>Type</th>
790
791
792
793
794
795 <th class="last">Description</th>
796 </tr>
797 </thead>
798
799 <tbody>
800
801
802 <tr>
803
804 <td class="name"><code>filePath</code></td>
805
806
807 <td class="type">
808
809
810<span class="param-type"><code>string</code></span>
811
812
813
814 </td>
815
816
817
818
819
820 <td class="description last">
821 <p>a path to pass to <code>require()</code></p>
822
823 </td>
824 </tr>
825
826
827 </tbody>
828</table>
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843<div class="section-returns">
844<h5>Returns:</h5>
845
846
847
848<dl class="param-type">
849 <dt>
850 Type:
851 </dt>
852 <dd>
853
854<span class="param-type"><code>Object</code></span>
855
856
857 </dd>
858</dl>
859
860
861<div class="param-desc">
862 <p>the object, or undefined, that was returned when<br>it was <code>require()</code>'ed.</p>
863</div>
864
865
866</div>
867
868
869
870</div>
871
872
873<div class="section-method">
874
875
876
877 <h4 class="name" id="%E2%8C%BE%E2%A0%80parse"><span class="type-signature">(async) </span>⌾⠀parse<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="GQLBase.html">GQLBase</a>>>}</span></h4>
878
879
880
881
882
883<div class="description">
884 <p>This method takes a instance of ModuleParser, initialized with a directory,<br>and walks its contents, importing files as they are found, and sorting<br>any exports that extend from GQLBase into an array of such classes<br>in a resolved promise.</p>
885</div>
886
887
888
889
890
891<dl class="details">
892
893
894
895
896 <dt class="tag-since">Since:</dt>
897 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921 <dt class="tag-source">Source:</dt>
922 <dd class="tag-source"><ul class="dummy"><li>
923 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line202">line 202</a>
924 </li></ul></dd>
925
926
927
928
929
930
931
932</dl>
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954<div class="section-returns">
955<h5>Returns:</h5>
956
957
958
959<dl class="param-type">
960 <dt>
961 Type:
962 </dt>
963 <dd>
964
965<span class="param-type"><code>Promise.&lt;Array.&lt;<a href="GQLBase.html">GQLBase</a>>></code></span>
966
967
968 </dd>
969</dl>
970
971
972<div class="param-desc">
973 <p>an array GQLBase classes, or an empty<br>array if none could be identified.</p>
974</div>
975
976
977</div>
978
979
980
981</div>
982
983
984<div class="section-method">
985
986
987
988 <h4 class="name" id="%E2%8C%BE%E2%A0%80parseSync"><span class="type-signature">(async) </span>⌾⠀parseSync<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="GQLBase.html">GQLBase</a>>}</span></h4>
989
990
991
992
993
994<div class="description">
995 <p>This method takes a instance of ModuleParser, initialized with a directory,<br>and walks its contents, importing files as they are found, and sorting<br>any exports that extend from GQLBase into an array of such classes</p>
996</div>
997
998
999
1000
1001
1002<dl class="details">
1003
1004
1005
1006
1007 <dt class="tag-since">Since:</dt>
1008 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032 <dt class="tag-source">Source:</dt>
1033 <dd class="tag-source"><ul class="dummy"><li>
1034 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line263">line 263</a>
1035 </li></ul></dd>
1036
1037
1038
1039
1040
1041
1042
1043</dl>
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065<div class="section-returns">
1066<h5>Returns:</h5>
1067
1068
1069
1070<dl class="param-type">
1071 <dt>
1072 Type:
1073 </dt>
1074 <dd>
1075
1076<span class="param-type"><code>Array.&lt;<a href="GQLBase.html">GQLBase</a>></code></span>
1077
1078
1079 </dd>
1080</dl>
1081
1082
1083<div class="param-desc">
1084 <p>an array GQLBase classes, or an empty<br>array if none could be identified.</p>
1085</div>
1086
1087
1088</div>
1089
1090
1091
1092</div>
1093
1094
1095<div class="section-method">
1096
1097
1098
1099 <h4 class="name" id="~%E2%8C%BE%E2%A0%80walk"><span class="type-signature">(async, inner) </span>⌾⠀walk<span class="signature">(dir, filelist)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;string>>}</span></h4>
1100
1101
1102
1103
1104
1105<div class="description">
1106 <p>Recursively walks a directory and returns an array of asbolute file paths<br>to the files under the specified directory.</p>
1107</div>
1108
1109
1110
1111
1112
1113<dl class="details">
1114
1115
1116
1117
1118 <dt class="tag-since">Since:</dt>
1119 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143 <dt class="tag-source">Source:</dt>
1144 <dd class="tag-source"><ul class="dummy"><li>
1145 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line372">line 372</a>
1146 </li></ul></dd>
1147
1148
1149
1150
1151
1152
1153
1154</dl>
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164 <h5>Parameters:</h5>
1165
1166
1167<table class="params">
1168 <thead>
1169 <tr>
1170
1171 <th>Name</th>
1172
1173
1174 <th>Type</th>
1175
1176
1177
1178
1179
1180 <th class="last">Description</th>
1181 </tr>
1182 </thead>
1183
1184 <tbody>
1185
1186
1187 <tr>
1188
1189 <td class="name"><code>dir</code></td>
1190
1191
1192 <td class="type">
1193
1194
1195<span class="param-type"><code>string</code></span>
1196
1197
1198
1199 </td>
1200
1201
1202
1203
1204
1205 <td class="description last">
1206 <p>string path to the top level directory to parse</p>
1207
1208 </td>
1209 </tr>
1210
1211
1212
1213 <tr>
1214
1215 <td class="name"><code>filelist</code></td>
1216
1217
1218 <td class="type">
1219
1220
1221<span class="param-type"><code>Array.&lt;string></code></span>
1222
1223
1224
1225 </td>
1226
1227
1228
1229
1230
1231 <td class="description last">
1232 <p>an array of existing absolute file paths,<br>or if not parameter is supplied a default empty array will be used.</p>
1233
1234 </td>
1235 </tr>
1236
1237
1238 </tbody>
1239</table>
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254<div class="section-returns">
1255<h5>Returns:</h5>
1256
1257
1258
1259<dl class="param-type">
1260 <dt>
1261 Type:
1262 </dt>
1263 <dd>
1264
1265<span class="param-type"><code>Promise.&lt;Array.&lt;string>></code></span>
1266
1267
1268 </dd>
1269</dl>
1270
1271
1272<div class="param-desc">
1273 <p>an array of existing absolute file paths<br>found under the supplied <code>dir</code> directory.</p>
1274</div>
1275
1276
1277</div>
1278
1279
1280
1281</div>
1282
1283
1284<div class="section-method">
1285
1286
1287
1288 <h4 class="name" id="~%E2%8C%BE%E2%A0%80walkSync"><span class="type-signature">(async, inner) </span>⌾⠀walkSync<span class="signature">(dir, filelist)</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>
1289
1290
1291
1292
1293
1294<div class="description">
1295 <p>Recursively walks a directory and returns an array of asbolute file paths<br>to the files under the specified directory. This version does this in a<br>synchronous fashion.</p>
1296</div>
1297
1298
1299
1300
1301
1302<dl class="details">
1303
1304
1305
1306
1307 <dt class="tag-since">Since:</dt>
1308 <dd class="tag-since"><ul class="dummy"><li>2.7.0</li></ul></dd>
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332 <dt class="tag-source">Source:</dt>
1333 <dd class="tag-source"><ul class="dummy"><li>
1334 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line412">line 412</a>
1335 </li></ul></dd>
1336
1337
1338
1339
1340
1341
1342
1343</dl>
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353 <h5>Parameters:</h5>
1354
1355
1356<table class="params">
1357 <thead>
1358 <tr>
1359
1360 <th>Name</th>
1361
1362
1363 <th>Type</th>
1364
1365
1366
1367
1368
1369 <th class="last">Description</th>
1370 </tr>
1371 </thead>
1372
1373 <tbody>
1374
1375
1376 <tr>
1377
1378 <td class="name"><code>dir</code></td>
1379
1380
1381 <td class="type">
1382
1383
1384<span class="param-type"><code>string</code></span>
1385
1386
1387
1388 </td>
1389
1390
1391
1392
1393
1394 <td class="description last">
1395 <p>string path to the top level directory to parse</p>
1396
1397 </td>
1398 </tr>
1399
1400
1401
1402 <tr>
1403
1404 <td class="name"><code>filelist</code></td>
1405
1406
1407 <td class="type">
1408
1409
1410<span class="param-type"><code>Array.&lt;string></code></span>
1411
1412
1413
1414 </td>
1415
1416
1417
1418
1419
1420 <td class="description last">
1421 <p>an array of existing absolute file paths,<br>or if not parameter is supplied a default empty array will be used.</p>
1422
1423 </td>
1424 </tr>
1425
1426
1427 </tbody>
1428</table>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443<div class="section-returns">
1444<h5>Returns:</h5>
1445
1446
1447
1448<dl class="param-type">
1449 <dt>
1450 Type:
1451 </dt>
1452 <dd>
1453
1454<span class="param-type"><code>Array.&lt;string></code></span>
1455
1456
1457 </dd>
1458</dl>
1459
1460
1461<div class="param-desc">
1462 <p>an array of existing absolute file paths found<br>under the supplied <code>dir</code> directory.</p>
1463</div>
1464
1465
1466</div>
1467
1468
1469
1470</div>
1471
1472
1473<div class="section-method">
1474
1475
1476
1477 <h4 class="name" id="~%E2%8E%86%E2%A0%80constructor"><span class="type-signature">(inner) </span>⎆⠀constructor<span class="signature">(directory)</span><span class="type-signature"></span></h4>
1478
1479
1480
1481
1482
1483<div class="description">
1484 <p>The constructor</p>
1485</div>
1486
1487
1488
1489
1490
1491<dl class="details">
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518 <dt class="tag-source">Source:</dt>
1519 <dd class="tag-source"><ul class="dummy"><li>
1520 <a href="ModuleParser.js.html">ModuleParser.js</a>, <a href="ModuleParser.js.html#line90">line 90</a>
1521 </li></ul></dd>
1522
1523
1524
1525
1526
1527
1528
1529</dl>
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539 <h5>Parameters:</h5>
1540
1541
1542<table class="params">
1543 <thead>
1544 <tr>
1545
1546 <th>Name</th>
1547
1548
1549 <th>Type</th>
1550
1551
1552
1553
1554
1555 <th class="last">Description</th>
1556 </tr>
1557 </thead>
1558
1559 <tbody>
1560
1561
1562 <tr>
1563
1564 <td class="name"><code>directory</code></td>
1565
1566
1567 <td class="type">
1568
1569
1570<span class="param-type"><code>string</code></span>
1571
1572
1573
1574 </td>
1575
1576
1577
1578
1579
1580 <td class="description last">
1581 <p>a string path to a directory containing the<br>various GQLBase extended classes that should be gathered.</p>
1582
1583 </td>
1584 </tr>
1585
1586
1587 </tbody>
1588</table>
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605</div>
1606
1607
1608
1609
1610
1611
1612</article>
1613
1614</section>
1615
1616
1617
1618
1619</div>
1620
1621<br class="clear">
1622
1623<footer>
1624 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.
1625</footer>
1626
1627<script>prettyPrint();</script>
1628<script src="scripts/linenumber.js"></script>
1629</body>
1630</html>
\No newline at end of file