This provides some utility types that help represent uncertain outcomes. More specifically: it provides TypeScript implementations of result and option types.
The API for these types is very closely modelled around the
Option and Result types in Rust. These Rust types are the inspiration for this library.
We also provide some helper types for dealing with options and results in asynchronous contexts. See AsyncOption and AsyncResult for more information.
Documentation (including an API reference) is available via GitHub Pages (here).
Contributions are very welcome! To contribute, first set up the repository. There are instructions for this below.
Open a branch and make whatever your changes. When you're ready, open a pull request for us to review!
When contributing, make sure that any additions are covered by unit tests. If you add or modify code, please ensure that you update the documentation to match your changes.
Also see our guide to contributing.