# Type safe Option and Result type

Inspired by Rust.

Previously known on npm as [tsp-monads](https://www.npmjs.com/package/tsp-monads).

[![CircleCI](https://img.shields.io/circleci/project/github/Threestup/monads.svg)](https://circleci.com/gh/Threestup/monads)
![Codecov](https://img.shields.io/codecov/c/github/Threestup/monads.svg)
[![npm version](https://img.shields.io/npm/v/@threestup/monads.svg)](https://www.npmjs.com/package/@threestup/monads) [![GuardRails badge](https://badges.production.guardrails.io/Threestup/monads.svg)](https://www.guardrails.io)

**NOTE:** Works with TypeScript 2+ _and_ JavaScript (ES6+). `strictNullChecks` option / flag strongly recommended.

## Documentation

- [Option Type](https://github.com/threestup/monads/tree/master/src/Option)
- [Result Type](https://github.com/threestup/monads/tree/master/src/Result)

## Install

```
npm install @threestup/monads
```

## Basic Usage

```typescript
import { Option, Some, None } from '@threestup/monads'

const divide = (numerator: number, denominator: number): Option<number> => {
    if (denominator === 0) {
        return None
    } else {
        return Some(numerator / denominator)
    }
};

// The return value of the function is an option
const result = divide(2.0, 3.0)

// Pattern match to retrieve the value
const message = result.match({
    some: res => `Result: ${res}`,
    none: 'Cannot divide by 0',
})

console.log(message) // 'Result: 0.6666666666666666'
```

```typescript
import { Result, Ok, Err } from '@threestup/monads'

function getIndex(values: string[], value: string): Result<number, string> {
    const index = values.indexOf(value)
    
    switch (index) {
        case -1:
            return Err('Value not found')
       default:
            return Ok(index)
    }
}

console.log(getIndex(['a', 'b', 'c'], 'b')) // Ok(1)
console.log(getIndex(['a', 'b', 'c'], 'z')) // Err('Value not found')
...
```

## Documentation

- [Option Type](https://github.com/threestup/monads/tree/master/src/Option)
- [Result Type](https://github.com/threestup/monads/tree/master/src/Result)