Add public tags and documentation in the error and config-loader packages

Part of #7688

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2021-10-20 22:01:33 +02:00
parent 7c95a556c4
commit 7e97d0b8c1
10 changed files with 41 additions and 15 deletions
+1 -1
View File
@@ -14,7 +14,7 @@ export class AuthenticationError extends CustomErrorBase {}
// @public
export class ConflictError extends CustomErrorBase {}
// @public (undocumented)
// @public
export class CustomErrorBase extends Error {
constructor(message?: string, cause?: Error | unknown);
// (undocumented)
+15 -1
View File
@@ -16,7 +16,21 @@
import { isError } from './assertion';
/** @public */
/**
* A base class that custom Error classes can inherit from.
*
* @public
* @example
*```ts
* class MyCustomError extends CustomErrorBase {}
*
* const e = new MyCustomError('Some message', cause);
* // e.name === 'MyCustomError'
* // e.message === 'Some message'
* // e.cause === cause
* // e.stack is set if the runtime supports it
* ```
*/
export class CustomErrorBase extends Error {
readonly cause?: Error;