From 7fd8606a1891c54c449a2f0b0062691c1530a0dc Mon Sep 17 00:00:00 2001 From: "Jing Xu(RainX)" Date: Tue, 26 Sep 2023 14:36:02 +0800 Subject: [PATCH] docs: revise the links of current API docs --- README.md | 2 +- ...l-exceptions-3507ae5a-1631-4d5e-856e-c607092a9031.json | 7 +++++++ packages/exceptions/README.md | 4 ++++ packages/exceptions/docs/README.md | 4 ++++ .../exceptions/docs/classes/BadFunctionCallException.md | 8 ++++---- .../exceptions/docs/classes/BadMethodCallException.md | 8 ++++---- packages/exceptions/docs/classes/BaseException.md | 6 +++--- packages/exceptions/docs/classes/DomainException.md | 8 ++++---- packages/exceptions/docs/classes/IgnorableException.md | 8 ++++---- .../exceptions/docs/classes/InvalidArgumentException.md | 8 ++++---- packages/exceptions/docs/classes/LengthException.md | 8 ++++---- packages/exceptions/docs/classes/LogicException.md | 8 ++++---- packages/exceptions/docs/classes/OutOfBoundsException.md | 8 ++++---- packages/exceptions/docs/classes/OutOfRangeException.md | 8 ++++---- packages/exceptions/docs/classes/OverflowException.md | 8 ++++---- packages/exceptions/docs/classes/RangeException.md | 8 ++++---- packages/exceptions/docs/classes/RuntimeException.md | 8 ++++---- packages/exceptions/docs/classes/UnderflowException.md | 8 ++++---- .../exceptions/docs/classes/UnexpectedValueException.md | 8 ++++---- 19 files changed, 75 insertions(+), 60 deletions(-) create mode 100644 change/@rightcapital-exceptions-3507ae5a-1631-4d5e-856e-c607092a9031.json diff --git a/README.md b/README.md index bb5eeaf..75ae960 100644 --- a/README.md +++ b/README.md @@ -109,4 +109,4 @@ We don't need to run the `publish` command locally. - https://pnpm.io/workspaces - https://microsoft.github.io/beachball/ - https://commitizen-tools.github.io/commitizen/ -- https://www.conventionalcommits.org/zh-hans/v1.0.0/#%e7%ba%a6%e5%ae%9a%e5%bc%8f%e6%8f%90%e4%ba%a4%e8%a7%84%e8%8c%83 +- https://www.conventionalcommits.org/ diff --git a/change/@rightcapital-exceptions-3507ae5a-1631-4d5e-856e-c607092a9031.json b/change/@rightcapital-exceptions-3507ae5a-1631-4d5e-856e-c607092a9031.json new file mode 100644 index 0000000..9816d70 --- /dev/null +++ b/change/@rightcapital-exceptions-3507ae5a-1631-4d5e-856e-c607092a9031.json @@ -0,0 +1,7 @@ +{ + "type": "patch", + "comment": "docs: revise the links of current API docs", + "packageName": "@rightcapital/exceptions", + "email": "i@rainx.cc", + "dependentChangeType": "patch" +} diff --git a/packages/exceptions/README.md b/packages/exceptions/README.md index a0a429d..1dcdf93 100644 --- a/packages/exceptions/README.md +++ b/packages/exceptions/README.md @@ -36,3 +36,7 @@ try { } } ``` + +## Modules + +[Here](/packages/exceptions/docs/modules.md) is the API documentation for the modules included in the package. diff --git a/packages/exceptions/docs/README.md b/packages/exceptions/docs/README.md index c4ddb16..4b9f0e5 100644 --- a/packages/exceptions/docs/README.md +++ b/packages/exceptions/docs/README.md @@ -38,3 +38,7 @@ try { } } ``` + +## Modules + +[Here](/packages/exceptions/docs/modules.md) is the API documentation for the modules included in the package. diff --git a/packages/exceptions/docs/classes/BadFunctionCallException.md b/packages/exceptions/docs/classes/BadFunctionCallException.md index 2b67db9..bd15ba3 100644 --- a/packages/exceptions/docs/classes/BadFunctionCallException.md +++ b/packages/exceptions/docs/classes/BadFunctionCallException.md @@ -48,7 +48,7 @@ Exception thrown if a callback refers to an undefined function or if some argume #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -64,7 +64,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/bad-function-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/bad-function-call.exception.ts#L8) +[packages/exceptions/src/exceptions/bad-function-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/bad-function-call.exception.ts#L8) ___ @@ -134,4 +134,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/BadMethodCallException.md b/packages/exceptions/docs/classes/BadMethodCallException.md index f4ad0ca..65565a5 100644 --- a/packages/exceptions/docs/classes/BadMethodCallException.md +++ b/packages/exceptions/docs/classes/BadMethodCallException.md @@ -46,7 +46,7 @@ Exception thrown if a callback refers to an undefined method or if some argument #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/bad-method-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/bad-method-call.exception.ts#L8) +[packages/exceptions/src/exceptions/bad-method-call.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/bad-method-call.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/BaseException.md b/packages/exceptions/docs/classes/BaseException.md index c4e2899..6488bb4 100644 --- a/packages/exceptions/docs/classes/BaseException.md +++ b/packages/exceptions/docs/classes/BaseException.md @@ -60,7 +60,7 @@ Error.constructor #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -72,7 +72,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -138,4 +138,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/DomainException.md b/packages/exceptions/docs/classes/DomainException.md index 5460310..880190e 100644 --- a/packages/exceptions/docs/classes/DomainException.md +++ b/packages/exceptions/docs/classes/DomainException.md @@ -46,7 +46,7 @@ Exception thrown if a value does not adhere to a defined valid data domain. #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/domain.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/domain.exception.ts#L8) +[packages/exceptions/src/exceptions/domain.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/domain.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/IgnorableException.md b/packages/exceptions/docs/classes/IgnorableException.md index 8b9a935..bf62414 100644 --- a/packages/exceptions/docs/classes/IgnorableException.md +++ b/packages/exceptions/docs/classes/IgnorableException.md @@ -46,7 +46,7 @@ This Exception could be ignore #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/ignorable.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/ignorable.exception.ts#L8) +[packages/exceptions/src/exceptions/ignorable.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/ignorable.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/InvalidArgumentException.md b/packages/exceptions/docs/classes/InvalidArgumentException.md index 9ea4190..eddd06c 100644 --- a/packages/exceptions/docs/classes/InvalidArgumentException.md +++ b/packages/exceptions/docs/classes/InvalidArgumentException.md @@ -46,7 +46,7 @@ Exception thrown if an argument is not of the expected type. #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/invalid-argument.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/invalid-argument.exception.ts#L8) +[packages/exceptions/src/exceptions/invalid-argument.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/invalid-argument.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/LengthException.md b/packages/exceptions/docs/classes/LengthException.md index efc361a..1c9bd41 100644 --- a/packages/exceptions/docs/classes/LengthException.md +++ b/packages/exceptions/docs/classes/LengthException.md @@ -46,7 +46,7 @@ Exception thrown if a length is invalid. #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/length.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/length.exception.ts#L8) +[packages/exceptions/src/exceptions/length.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/length.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/LogicException.md b/packages/exceptions/docs/classes/LogicException.md index 95c0050..7d1d2d8 100644 --- a/packages/exceptions/docs/classes/LogicException.md +++ b/packages/exceptions/docs/classes/LogicException.md @@ -56,7 +56,7 @@ Exception that represents error in the program logic. This kind of exception sho #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -72,7 +72,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -100,7 +100,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/logic.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/logic.exception.ts#L8) +[packages/exceptions/src/exceptions/logic.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/logic.exception.ts#L8) ___ @@ -142,4 +142,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/OutOfBoundsException.md b/packages/exceptions/docs/classes/OutOfBoundsException.md index f5dae7b..d33c45c 100644 --- a/packages/exceptions/docs/classes/OutOfBoundsException.md +++ b/packages/exceptions/docs/classes/OutOfBoundsException.md @@ -46,7 +46,7 @@ Exception thrown if a value is not a valid key. This represents errors that cann #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/out-of-bounds.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/out-of-bounds.exception.ts#L8) +[packages/exceptions/src/exceptions/out-of-bounds.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/out-of-bounds.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/OutOfRangeException.md b/packages/exceptions/docs/classes/OutOfRangeException.md index b763040..4519b5f 100644 --- a/packages/exceptions/docs/classes/OutOfRangeException.md +++ b/packages/exceptions/docs/classes/OutOfRangeException.md @@ -46,7 +46,7 @@ Exception thrown when an illegal index was requested. This represents errors tha #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/out-of-range.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/out-of-range.exception.ts#L8) +[packages/exceptions/src/exceptions/out-of-range.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/out-of-range.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/OverflowException.md b/packages/exceptions/docs/classes/OverflowException.md index 3c65446..aeceea0 100644 --- a/packages/exceptions/docs/classes/OverflowException.md +++ b/packages/exceptions/docs/classes/OverflowException.md @@ -46,7 +46,7 @@ Exception thrown when adding an element to a full container. #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/overflow.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/overflow.exception.ts#L8) +[packages/exceptions/src/exceptions/overflow.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/overflow.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/RangeException.md b/packages/exceptions/docs/classes/RangeException.md index baa7682..b925f94 100644 --- a/packages/exceptions/docs/classes/RangeException.md +++ b/packages/exceptions/docs/classes/RangeException.md @@ -51,7 +51,7 @@ DomainException. #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -67,7 +67,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -95,7 +95,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/range.exception.ts:9](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/range.exception.ts#L9) +[packages/exceptions/src/exceptions/range.exception.ts:9](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/range.exception.ts#L9) ___ @@ -137,4 +137,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/RuntimeException.md b/packages/exceptions/docs/classes/RuntimeException.md index 37c9f39..7c72964 100644 --- a/packages/exceptions/docs/classes/RuntimeException.md +++ b/packages/exceptions/docs/classes/RuntimeException.md @@ -54,7 +54,7 @@ Exception thrown if an error which can only be found on runtime occurs. #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -70,7 +70,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -98,7 +98,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/runtime.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/runtime.exception.ts#L8) +[packages/exceptions/src/exceptions/runtime.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/runtime.exception.ts#L8) ___ @@ -140,4 +140,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/UnderflowException.md b/packages/exceptions/docs/classes/UnderflowException.md index 012a979..c4bef91 100644 --- a/packages/exceptions/docs/classes/UnderflowException.md +++ b/packages/exceptions/docs/classes/UnderflowException.md @@ -46,7 +46,7 @@ Exception thrown when performing an invalid operation on an empty container, suc #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -62,7 +62,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -90,7 +90,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/underflow.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/underflow.exception.ts#L8) +[packages/exceptions/src/exceptions/underflow.exception.ts:8](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/underflow.exception.ts#L8) ___ @@ -132,4 +132,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27) diff --git a/packages/exceptions/docs/classes/UnexpectedValueException.md b/packages/exceptions/docs/classes/UnexpectedValueException.md index 92a493e..c3eafd1 100644 --- a/packages/exceptions/docs/classes/UnexpectedValueException.md +++ b/packages/exceptions/docs/classes/UnexpectedValueException.md @@ -48,7 +48,7 @@ expects the return value to be of a certain type or value not including arithmet #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L14) +[packages/exceptions/src/exceptions/base.exception.ts:14](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L14) ## Properties @@ -64,7 +64,7 @@ The value of cause can be of any type. You should not make assumptions that the #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L16) +[packages/exceptions/src/exceptions/base.exception.ts:16](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L16) ___ @@ -92,7 +92,7 @@ ___ #### Defined in -[packages/exceptions/src/exceptions/unexpected-value.exception.ts:10](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/unexpected-value.exception.ts#L10) +[packages/exceptions/src/exceptions/unexpected-value.exception.ts:10](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/unexpected-value.exception.ts#L10) ___ @@ -134,4 +134,4 @@ true if the cause we passed is the original cause when the Exception constructed #### Defined in -[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/98a64d7/packages/exceptions/src/exceptions/base.exception.ts#L27) +[packages/exceptions/src/exceptions/base.exception.ts:27](https://github.com/RightCapitalHQ/frontend-libraries/blob/d583627/packages/exceptions/src/exceptions/base.exception.ts#L27)