@nyteshade/lattice-legacy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>IDLFileHandler.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="AwaitingPromiseError.html">AwaitingPromiseError</a></li><li class="nav-item">F<a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580asyncFn">⌾⠀asyncFn</a></li><li class="nav-item">F<a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580setPromise">⌾⠀setPromise</a></li><li class="nav-heading">C<a href="AwaitingPromiseError_exports.AwaitingPromiseError.html">AwaitingPromiseError</a></li><li class="nav-item">F<a href="AwaitingPromiseError_exports.AwaitingPromiseError.html#setPromise">setPromise</a></li><li class="nav-heading">C<a href="Deferred_exports.Deferred.html">Deferred</a></li><li class="nav-heading">C<a href="DirectTypeAdd.html">DirectTypeAdd</a></li><li class="nav-heading">C<a href="FunctionExecutionError_FunctionExecutionError.html">FunctionExecutionError</a></li><li class="nav-heading">C<a href="GQLBase.html">GQLBase</a></li><li class="nav-item">F<a href="GQLBase.html#.apiDocs">apiDocs</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getMergedRoot">⌾⠀getMergedRoot</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580IDLFilePath">⌾⠀IDLFilePath</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580MUTATORS">⌾⠀MUTATORS</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580RESOLVERS">⌾⠀RESOLVERS</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580setupModel">⌾⠀setupModel</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580handler">⬇︎⠀handler</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580SCHEMA">⬇︎⠀SCHEMA</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580applyAutoProps">⌾⠀applyAutoProps</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580callProp">⌾⠀callProp</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580extendModel">⌾⠀extendModel</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getModel">⌾⠀getModel</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580setModel">⌾⠀setModel</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580requestData">⬆︎⠀requestData</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580requestData">⬇︎⠀requestData</a></li><li class="nav-item">F<a href="GQLBase.html#~deleteProperty">deleteProperty</a></li><li class="nav-item">F<a href="GQLBase.html#~set">set</a></li><li class="nav-heading">C<a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></li><li class="nav-heading">C<a href="GQLEnum.html">GQLEnum</a></li><li class="nav-item">F<a href="GQLEnum.html#..get">.get</a></li><li class="nav-item">F<a href="GQLEnum.html#..set">.set</a></li><li class="nav-item">F<a href="GQLEnum.html#.valueFor">valueFor</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580enums">⬇︎⠀enums</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580name">⬇︎⠀name</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580value">⬇︎⠀value</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580values">⬇︎⠀values</a></li><li class="nav-item">F<a href="GQLEnum.html#GenerateEnumsProxyHandler">GenerateEnumsProxyHandler</a></li><li class="nav-heading">C<a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#.clearCache">clearCache</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#.%25E2%258C%25BE%25E2%25A0%2580generateSchemaSDL">⌾⠀generateSchemaSDL</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#astMiddleware">astMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#schemaMiddleware">schemaMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%258C%25BE%25E2%25A0%2580customMiddleware">⌾⠀customMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middleware">⬇︎⠀middleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middlewareWithoutGraphiQL">⬇︎⠀middlewareWithoutGraphiQL</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580schema">⬇︎⠀schema</a></li><li class="nav-heading">C<a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></li><li class="nav-heading">C<a href="GQLInterface.html">GQLInterface</a></li><li class="nav-item">F<a href="GQLInterface.html#.%25E2%258C%25BE%25E2%25A0%2580resolveType">⌾⠀resolveType</a></li><li class="nav-heading">C<a href="GQLScalar.html">GQLScalar</a></li><li class="nav-item">F<a href="GQLScalar.html#.parseLiteral">parseLiteral</a></li><li class="nav-item">F<a href="GQLScalar.html#.parseValue">parseValue</a></li><li class="nav-item">F<a href="GQLScalar.html#.serialize">serialize</a></li><li class="nav-heading">C<a href="IDLFileHandler.html">IDLFileHandler</a></li><li class="nav-item">F<a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getFile">⌾⠀getFile</a></li><li class="nav-item">F<a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSchema">⌾⠀getSchema</a></li><li class="nav-item">F<a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSyntaxTree">⌾⠀getSyntaxTree</a></li><li class="nav-heading">C<a href="IDLFileHandler.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></li><li class="nav-heading">C<a href="ModuleParser.html">ModuleParser</a></li><li class="nav-item">F<a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580arrayToPattern">⌾⠀arrayToPattern</a></li><li class="nav-item">F<a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580checkForPackageExtensions">⌾⠀checkForPackageExtensions</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580findGQLBaseClasses">⌾⠀findGQLBaseClasses</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580importClass">⌾⠀importClass</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parse">⌾⠀parse</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parseSync">⌾⠀parseSync</a></li><li class="nav-item">F<a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walk">⌾⠀walk</a></li><li class="nav-item">F<a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walkSync">⌾⠀walkSync</a></li><li class="nav-item">F<a href="ModuleParser.html#~%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></li><li class="nav-heading">C<a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></li><li class="nav-heading">C<a href="SchemaUtils.html">SchemaUtils</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580createMergedRoot">⌾⠀createMergedRoot</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectComments">⌾⠀injectComments</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectEnums">⌾⠀injectEnums</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectInterfaceResolvers">⌾⠀injectInterfaceResolvers</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectScalars">⌾⠀injectScalars</a></li><li class="nav-heading">C<a href="SyntaxTree.html">SyntaxTree</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyDocument">⌾⠀EmptyDocument</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyMutation">⌾⠀EmptyMutation</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyQuery">⌾⠀EmptyQuery</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findDefinition">⌾⠀findDefinition</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findField">⌾⠀findField</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findInASTArrayByNameValue">⌾⠀findInASTArrayByNameValue</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580from">⌾⠀from</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromAST">⌾⠀fromAST</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromSchema">⌾⠀fromSchema</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580appendDefinitions">⌾⠀appendDefinitions</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580consumeDefinition">⌾⠀consumeDefinition</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580find">⌾⠀find</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580findEnumDefinition">⌾⠀findEnumDefinition</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580setAST">⌾⠀setAST</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580toString">⌾⠀toString</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580updateAST">⌾⠀updateAST</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580ast">⬆︎⠀ast</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580ast">⬇︎⠀ast</a></li><li class="nav-heading">C<a href="utils.Deferred.html">Deferred</a></li><li class="nav-heading">Namespaces</li><li class="nav-heading">N<a href="decorators.html">decorators</a></li><li class="nav-item">F<a href="decorators.html#.%25E2%258C%25BE%25E2%25A0%2580extractBits">⌾⠀extractBits</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580AdjacentSchema">.🏷⠀AdjacentSchema</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580FileSchema">.🏷⠀FileSchema</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Getters">.🏷⠀Getters</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Properties">.🏷⠀Properties</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Schema">.🏷⠀Schema</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Setters">.🏷⠀Setters</a></li><li class="nav-item">F<a href="decorators.html#~decorate">decorate</a></li><li class="nav-heading">N<a href="GQLBaseEnv.html">GQLBaseEnv</a></li><li class="nav-item">F<a href="GQLBaseEnv.html#~notDefined">notDefined</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">F<a href="global.html#applyTags">applyTags</a></li><li class="nav-item">M<a href="global.html#AsyncFunctionExecutionError">AsyncFunctionExecutionError</a></li><li class="nav-item">M<a href="global.html#CHECK_API_DOCS">CHECK_API_DOCS</a></li><li class="nav-item">M<a href="global.html#CHECK_RESOLVERS">CHECK_RESOLVERS</a></li><li class="nav-item">M<a href="global.html#CHECK_SCHEMA">CHECK_SCHEMA</a></li><li class="nav-item">M<a href="global.html#CHECKLIST">CHECKLIST</a></li><li class="nav-item">M<a href="global.html#FunctionExecutionError">FunctionExecutionError</a></li><li class="nav-item">F<a href="global.html#getChecklist">getChecklist</a></li><li class="nav-item">F<a href="global.html#hasChecklist">hasChecklist</a></li><li class="nav-item">F<a href="global.html#newChecklist">newChecklist</a></li><li class="nav-item">F<a href="global.html#setChecklist">setChecklist</a></li><li class="nav-item">M<a href="global.html#types">types</a></li> </nav> <div id="main"> <h1 class="page-title">IDLFileHandler.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** * The handler, an instance of which is created for every instance of GQLBase. * The handler manages the fetching and decoding of files bearing the IDL * schema associated with the class represented by this instance of GQLBase. * * @class IDLFileHandler */ export class IDLFileHandler { path: ?string; extension: ?string; /** * The IDLFileHandler checks the SCHEMA value returned by the class type * of the supplied instance. If the resulting value is a Symbol, then the * handler's responsibility is to find the file, load it from disk and * provide various means of using its contents; i.e. as a Buffer, a String * or wrapped in a SyntaxTree instance. * * @memberof IDLFileHandler * @method ⎆⠀constructor * @constructor * * @param {Function} Class a function or class definition that presumably * extends from GQLBase were it an instance. */ constructor(Class: Function) { // $FlowFixMe const symbol = typeof Class.SCHEMA === 'symbol' && Class.SCHEMA || null; const pattern = /Symbol$Path (.*?) Extension (.*?)$/; if (symbol) { let symbolString = symbol.toString(); if (symbol === Class.ADJACENT_FILE) { if (Class.module === module) { throw new Error(` The a static getter for 'module' on ${Class.name} must be present that returns the module object where the Class is defined. Try the following: // your ${Class.name}.js file import { GQLBase } from 'graphql-lattice' const ${Class.name}Module = module; class ${Class.name} extends GQLBase { ... static get module() { return ${Class.name}Module; } } `); } const filename = Class.module.filename; const extension = Path.extname(filename) const dir = Path.dirname(filename) const filefixed = Path.basename(filename, extension) const build = Path.resolve(Path.join(dir, `${filefixed}.graphql`)) this.path = build; this.extension = '.graphql'; } else if (pattern.test(symbolString)) { const parsed = pattern.exec(symbolString); const extension = parsed[2] || '.graphql' const dir = Path.dirname(parsed[1]) const file = Path.basename(parsed[1], extension) const build = Path.resolve(Path.join(dir, `${file}${extension}`)) this.path = build; this.extension = extension; } } else { this.path = this.extension = null; } } /** * Loads the calculated file determined by the decoding of the meaning of * the Symbol returned by the SCHEMA property of the instance supplied to * the IDLFileHandler upon creation. * * @instance * @memberof IDLFileHandler * @method ⌾⠀getFile * * @return {Buffer|null} returns the Buffer containing the file base IDL * schema or null if none was found or a direct string schema is returned * by the SCHEMA property */ getFile(): Buffer { return fs.readFileSync(String(this.path)); } /** * If getFile() returns a Buffer, this is the string representation of the * underlying file contents. As a means of validating the contents of the * file, the string contents are parsed into an AST and back to a string. * * @instance * @memberof IDLFileHandler * @method ⌾⠀getSchema * * @return {string|null} the string contents of the Buffer containing the * file based IDL schema. */ getSchema(): ?string { if (!this.path) { return null; } const tree = this.getSyntaxTree(); return tree.toString(); } /** * If getFile() returns a Buffer, the string contents are passed to a new * instance of SyntaxTree which parses this into an AST for manipulation. * * @instance * @memberof IDLFileHandler * @method ⌾⠀getSyntaxTree * * @return {SyntaxTree|null} a SyntaxTree instance constructed from the IDL * schema contents loaded from disk. Null is returned if a calculated path * cannot be found; always occurs when SCHEMA returns a string. */ getSyntaxTree(): SyntaxTree { const buffer = this.getFile(); const tree = new SyntaxTree(buffer.toString()); return tree; } /** * Returns the `constructor` name. If invoked as the context, or `this`, * object of the `toString` method of `Object`'s `prototype`, the resulting * value will be `[object MyClass]`, given an instance of `MyClass` * * @method ⌾⠀[Symbol.toStringTag] * @memberof IDLFileHandler * * @return {string} the name of the class this is an instance of * @ComputedType */ get [Symbol.toStringTag]() { return this.constructor.name } /** * Applies the same logic as {@link #[Symbol.toStringTag]} but on a static * scale. So, if you perform `Object.prototype.toString.call(MyClass)` * the result would be `[object MyClass]`. * * @method ⌾⠀[Symbol.toStringTag] * @memberof IDLFileHandler * @static * * @return {string} the name of this class * @ComputedType */ static get [Symbol.toStringTag]() { return this.name } } export default IDLFileHandler</code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Feb 17 2018 00:27:31 GMT-0800 (PST) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>