Installation
npm install --save @types/semantic-release__error
Summary
This package contains type definitions for @semantic-release/error (https://github.com/semantic-release/error).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/semantic-release__error.
index.d.ts
/**
* Error type used by all [semantic-release](https://github.com/semantic-release/semantic-release) packages.
*
* Errors of type `SemanticReleaseError` or an inherited type will be considered by
* [semantic-release](https://github.com/semantic-release/semantic-release) as an expected exception case
* (no release to be done, running on a PR etc..). That indicate to the `semantic-release` process to stop
* and exit with the `0` success code.
*
* Any other type of error will be considered by
* [semantic-release](https://github.com/semantic-release/semantic-release) as an unexpected error
* (i/o issue, code problem etc...). That indicate to the `semantic-release` process to stop, log the error
* and exit with the `1` failure code.
*
* @example
* import SemanticReleaseError = require("@semantic-release/error");
*
* // Default
* throw new SemanticReleaseError();
*
* // With error message
* throw new SemanticReleaseError("An error happened");
*
* // With error message and error code
* throw new SemanticReleaseError("An error happened", "ECODE");
*
* // With error message, error code and details
* throw new SemanticReleaseError("An error happened", "ECODE", "Here is some suggestions to solve this error.");
*
* // With inheritance
* class InheritedError extends SemanticReleaseError {
* constructor(message, code, newProperty, details) {
* super(message);
* Error.captureStackTrace(this, this.constructor);
* this.name = this.constructor.name;
* this.code = code;
* this.details = details;
* this.newProperty = "newProperty";
* }
* }
*
* throw new InheritedError("An error happened", "ECODE", "Here is some suggestions to solve this error.");
*/
declare class SemanticReleaseError extends Error {
name: "SemanticReleaseError";
code: string | undefined;
details: string | undefined;
semanticRelease: true;
constructor(message?: string, code?: string, details?: string);
}
export = SemanticReleaseError;
Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: none
Credits
These definitions were written by Alex Mendes, and BendingBender.