resultar 0.8.2 → 0.8.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,11 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## About
|
|
4
4
|
|
|
5
|
-
Resultar is a TypeScript library
|
|
5
|
+
Resultar is a TypeScript library for robust, type-safe error handling without throwing exceptions. It's a fork of the excellent [neverthrow](https://github.com/supermacro/neverthrow) library, adding features for more flexibility in error handling
|
|
6
6
|
|
|
7
|
-
In the spirit of open-source development, **resultar** builds upon the solid foundation laid by neverthrow, extending its functionality to better suit specific needs. It introduces additional methods and functions such as tap, safeTryAsync, and fromThrowableAsync
|
|
8
|
-
|
|
9
|
-
While resultar owes its origins to neverthrow, it has evolved to offer its own unique features, making error handling in TypeScript even more powerful and expressive. It's a testament to the power of open-source collaboration and the continuous pursuit of improving code quality and developer experience.
|
|
7
|
+
In the spirit of open-source development, **resultar** builds upon the solid foundation laid by neverthrow, extending its functionality to better suit specific needs. It introduces additional methods and functions such as tap, safeTryAsync, and fromThrowableAsync and finally providing more flexibility and control in error handling.
|
|
10
8
|
|
|
11
9
|
## Description
|
|
12
10
|
|
|
@@ -16,9 +14,9 @@ This package contains a `Result` type that represents either success (`Ok`) or f
|
|
|
16
14
|
|
|
17
15
|
For asynchronous tasks, `resultar` offers a `ResultAsync` class which wraps a `Promise<Result<T, E>>` and gives you the same level of expressivity and control as a regular `Result<T, E>`.
|
|
18
16
|
|
|
19
|
-
`ResultAsync` is `thenable` meaning it **behaves exactly like a native `Promise<Result>`** ... except you have access to the same methods that `Result` provides without having to `await` or `.then` the promise!
|
|
17
|
+
`ResultAsync` is `thenable` meaning it **behaves exactly like a native `Promise<Result>`** ... except you have access to the same methods that `Result` provides without having to `await` or `.then` the promise!
|
|
20
18
|
|
|
21
|
-
|
|
19
|
+
### Check out [the wiki](https://github.com/inaiat/resultar/wiki) for examples and best practices.
|
|
22
20
|
|
|
23
21
|
<div id="toc"></div>
|
|
24
22
|
|