77 lines
No EOL
2.8 KiB
Text
77 lines
No EOL
2.8 KiB
Text
// Type definitions for verror 1.10
|
|
// Project: https://github.com/davepacheco/node-verror
|
|
// Definitions by: Sven Reglitzki <https://github.com/svi3c>, Maxime Toumi-M <https://github.com/max4t>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/*
|
|
* VError([cause], fmt[, arg...]): Like JavaScript's built-in Error class, but
|
|
* supports a "cause" argument (another error) and a printf-style message. The
|
|
* cause argument can be null or omitted entirely.
|
|
*
|
|
* Examples:
|
|
*
|
|
* CODE MESSAGE
|
|
* new VError('something bad happened') "something bad happened"
|
|
* new VError('missing file: "%s"', file) "missing file: "/etc/passwd"
|
|
* with file = '/etc/passwd'
|
|
* new VError(err, 'open failed') "open failed: file not found"
|
|
* with err.message = 'file not found'
|
|
*/
|
|
declare class VError extends Error {
|
|
static VError: typeof VError;
|
|
|
|
static cause(err: Error): Error | null;
|
|
static info(err: Error): VError.Info;
|
|
static fullStack(err: Error): string;
|
|
static findCauseByName(err: Error, name: string): Error | null;
|
|
static hasCauseWithName(err: Error, name: string): boolean;
|
|
static errorFromList<T extends Error>(errors: T[]): null | T | VError.MultiError;
|
|
static errorForEach(err: Error, func: (err: Error) => void): void;
|
|
|
|
//@ts-ignore
|
|
cause(): Error | undefined;
|
|
constructor(options: VError.Options | Error, message: string, ...params: any[]);
|
|
constructor(message?: string, ...params: any[]);
|
|
}
|
|
|
|
declare namespace VError {
|
|
interface Info {
|
|
[key: string]: any;
|
|
}
|
|
|
|
interface Options {
|
|
cause?: Error | null | undefined;
|
|
name?: string | undefined;
|
|
strict?: boolean | undefined;
|
|
constructorOpt?(...args: any[]): void;
|
|
info?: Info | undefined;
|
|
}
|
|
|
|
/*
|
|
* SError is like VError, but stricter about types. You cannot pass "null" or
|
|
* "undefined" as string arguments to the formatter. Since SError is only a
|
|
* different function, not really a different class, we don't set
|
|
* SError.prototype.name.
|
|
*/
|
|
class SError extends VError {}
|
|
|
|
/*
|
|
* Represents a collection of errors for the purpose of consumers that generally
|
|
* only deal with one error. Callers can extract the individual errors
|
|
* contained in this object, but may also just treat it as a normal single
|
|
* error, in which case a summary message will be printed.
|
|
*/
|
|
class MultiError extends VError {
|
|
constructor(errors: Error[]);
|
|
errors(): Error[];
|
|
}
|
|
|
|
/*
|
|
* Like JavaScript's built-in Error class, but supports a "cause" argument which
|
|
* is wrapped, not "folded in" as with VError. Accepts a printf-style message.
|
|
* The cause argument can be null.
|
|
*/
|
|
class WError extends VError {}
|
|
}
|
|
|
|
export = VError; |