@nyteshade/lattice-legacy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>errors/AwaitingPromiseError.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">errors/AwaitingPromiseError.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>import { AsyncFunctionExecutionError } from './AsyncFunctionExecutionError' /** * An error that occurs while waiting for a Promise or asynchronous function * to resolve. Typically found in the catch() handler of a promise or the * try/catch handler of an `await asyncFn()` statement. In addition to an * error message that occurred during the asynchronous event, this error * can track other potentially pertinent information such as the promise * in question and/or an AsyncFunctionExecutionError wrapping the originally * thrown generic error. * * @class AwaitingPromiseError */ export class AwaitingPromiseError extends Error { /** * The promise that threw an error if available. * * @type {Promise<mixed>} * @instance * @memberOf AwaitingPromiseError */ promise: Promise<mixed> /** * The error that spawned the creation of this Error instance. Specifically, * it is better if this error is an instance of AsyncFunctionExecutionError * * @type {Error} * @instance * @memberOf AwaitingPromiseError */ error: Error /** * Creates a new instance of AwaitingPromiseError. It takes the same default * parameters of the core Error class. * * @constructor * * @param {Error|string} error the error or message to describe what happened * @param {string} fileName the name of the file, see Error for more detail * @param {number} lineNumber line number of the error, see Error for more */ constructor( error: ?Error|string, fileName: ?string, lineNumber: number = NaN ) { let message = error instanceof Error ? error.message : error super(message || error, fileName, lineNumber) if (error instanceof Error) { let { columnNumber, fileName, lineNumber, message, name, stack } = error Object.assign(this, { columnNumber, fileName, lineNumber, message, name, stack }) this.error = error } } /** * A promise that potentially spawned the error is something that this type * of Error tracks. You can set this inline with a return statement by using * this helper function. * * i.e. * ``` * let promise; // define elsewhere * promise * .then(result => ({})) * .catch(error => { * throw new AwaitingPromiseError(error).setPromise(promise) * }) * ``` * * @method ⌾⠀setPromise * @memberof AwaitingPromiseError * @instance * * @param {Promise<mixed>} promise the promise to store as a chained call * @return {AwaitingPromiseError} `this` for use in a chained function call */ setPromise(promise: Promise<mixed>): AwaitingPromiseError { this.promise = promise return this } /** * A static helper method that creates an error but also takes and records * the additional data with regards to the associated async function call * that caused the error to occur. Optionally a promise can be assigned by * giving one as the last parameter. * * @method ⌾⠀asyncFn * @memberof AwaitingPromiseError * @instance * * @param {Error|string} error any error present at the time of failure * @param {Function} fn the function that failed * @param {Array<mixed>} args any arguments passed to the failed fn * @param {mixed} result any result returned by the failed function * @param {Promise<mixed>} promise an associated promise, if available * * @return {AwaitingPromiseError} a newly minted AwaitingPromiseError with * all the specified data */ static asyncFn( error: (Error | string), fn: ?Function, args: ?Array<mixed>, result: ?mixed, promise: ?Promise<mixed> ): AwaitingPromiseError { let preciseError = new AsyncFunctionExecutionError(error, fn, args, result) let finalError = new AwaitingPromiseError(preciseError) if (promise) { finalError.setPromise(promise) } return finalError } } export default AwaitingPromiseError</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>