This package has been deprecated

Author message:

WARNING: This project has been renamed to @threestup/monads. Install using @threestup/monads instead.

tsp-monads

Type safe Option and Result type

Inspired by Rust

NOTE: Works with TypeScript 2.1+ and JavaScript. strictNullChecks option / flag is strongly recommended.

Documentation

• Option Type
• Result Type

Install

yarn add tsp-monads

Basic Usage

import { Option, Some, None } from 'tsp-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: _ => `Result: ${_}`,
    none: 'Cannot divide by 0',
});
 
console.log(message); // 'Result: 0.6666666666666666'

import { Result, Ok, Err } from 'tsp-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
• Result Type