mirror of
https://github.com/sablierapp/sablier.git
synced 2026-01-04 20:14:58 +01:00
docs(release): update doc version from 1.2.0 to 1.3.0-beta.1 [skip ci]
This commit is contained in:
41
node_modules/@semantic-release/error/README.md
generated
vendored
Normal file
41
node_modules/@semantic-release/error/README.md
generated
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
# @semantic-release/error
|
||||
|
||||
Error type used by all [semantic-release](https://github.com/semantic-release/semantic-release) packages.
|
||||
|
||||
[](https://github.com/semantic-release/error/actions?query=workflow%3ATest+branch%3Amaster)
|
||||
|
||||
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.
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const 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.");
|
||||
```
|
||||
Reference in New Issue
Block a user