# ts-results-es

A TypeScript implementation of Rust's [Result](https://doc.rust-lang.org/std/result/)
and [Option](https://doc.rust-lang.org/std/option/) objects.

Brings compile-time error checking and optional values to TypeScript.

* [The package on NPM](https://www.npmjs.com/package/ts-results-es)
* [Documentation](https://ts-results-es.readthedocs.io)

## Contents

-   [Installation](#installation)
-   [Example](#example)
    -   [Result Example](#result-example)
    -   [Option Example](#option-example)
-   [Usage](#usage)

## Installation

```bash
$ npm install ts-results-es
```

or

```bash
$ yarn add ts-results-es
```

## Usage

See https://ts-results-es.readthedocs.io/en/latest/reference/index.html to see the API
reference.