|
|
@@ -1,83 +0,0 @@
|
|
|
-export = OError;
|
|
|
-/**
|
|
|
- * Light-weight helpers for handling JavaScript Errors in node.js and the
|
|
|
- * browser.
|
|
|
- */
|
|
|
-declare class OError extends Error {
|
|
|
- /**
|
|
|
- * @param {string} message as for built-in Error
|
|
|
- * @param {Object} [info] extra data to attach to the error
|
|
|
- * @param {Error} [cause] the internal error that caused this error
|
|
|
- */
|
|
|
- constructor(message: string, info?: any, cause?: Error);
|
|
|
- info: any;
|
|
|
- cause: Error;
|
|
|
- /** @private @type {Array<TaggedError> | undefined} */
|
|
|
- private _oErrorTags;
|
|
|
- /**
|
|
|
- * Set the extra info object for this error.
|
|
|
- *
|
|
|
- * @param {Object} info extra data to attach to the error
|
|
|
- * @return {this}
|
|
|
- */
|
|
|
- withInfo(info: any): OError;
|
|
|
- /**
|
|
|
- * Wrap the given error, which caused this error.
|
|
|
- *
|
|
|
- * @param {Error} cause the internal error that caused this error
|
|
|
- * @return {this}
|
|
|
- */
|
|
|
- withCause(cause: Error): OError;
|
|
|
-}
|
|
|
-declare namespace OError {
|
|
|
- /**
|
|
|
- * Tag debugging information onto any error (whether an OError or not) and
|
|
|
- * return it.
|
|
|
- *
|
|
|
- * @example <caption>An error in a callback</caption>
|
|
|
- * function findUser(name, callback) {
|
|
|
- * fs.readFile('/etc/passwd', (err, data) => {
|
|
|
- * if (err) return callback(OError.tag(err, 'failed to read passwd'))
|
|
|
- * // ...
|
|
|
- * })
|
|
|
- * }
|
|
|
- *
|
|
|
- * @example <caption>A possible error in a callback</caption>
|
|
|
- * function cleanup(callback) {
|
|
|
- * fs.unlink('/tmp/scratch', (err) => callback(err && OError.tag(err)))
|
|
|
- * }
|
|
|
- *
|
|
|
- * @example <caption>An error with async/await</caption>
|
|
|
- * async function cleanup() {
|
|
|
- * try {
|
|
|
- * await fs.promises.unlink('/tmp/scratch')
|
|
|
- * } catch (err) {
|
|
|
- * throw OError.tag(err, 'failed to remove scratch file')
|
|
|
- * }
|
|
|
- * }
|
|
|
- *
|
|
|
- * @param {Error} error the error to tag
|
|
|
- * @param {string} [message] message with which to tag `error`
|
|
|
- * @param {Object} [info] extra data with wich to tag `error`
|
|
|
- * @return {Error} the modified `error` argument
|
|
|
- */
|
|
|
- export function tag(error: Error, message?: string, info?: any): Error;
|
|
|
- /**
|
|
|
- * The merged info from any `tag`s and causes on the given error.
|
|
|
- *
|
|
|
- * If an info property is repeated, the last one wins.
|
|
|
- *
|
|
|
- * @param {Error | null | undefined} error any error (may or may not be an `OError`)
|
|
|
- * @return {Object}
|
|
|
- */
|
|
|
- export function getFullInfo(error: Error): any;
|
|
|
- /**
|
|
|
- * Return the `stack` property from `error`, including the `stack`s for any
|
|
|
- * tagged errors added with `OError.tag` and for any `cause`s.
|
|
|
- *
|
|
|
- * @param {Error | null | undefined} error any error (may or may not be an `OError`)
|
|
|
- * @return {string}
|
|
|
- */
|
|
|
- export function getFullStack(error: Error): string;
|
|
|
- export const maxTags: Number;
|
|
|
-}
|