# Monapt
[](http://badge.fury.io/js/monapt)
[](https://circleci.com/gh/jiaweihli/monapt)
[](https://coveralls.io/github/jiaweihli/monapt)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
[](https://conventionalcommits.org)
Monapt helps you better manage `null`, `undefined`, exceptions, and other mildly interesting
phenomena. It handles them through the
[`Option`](http://danielwestheide.com/blog/2012/12/19/the-neophytes-guide-to-scala-part-5-the-option-type.html),
[`Try`](http://danielwestheide.com/blog/2012/12/26/the-neophytes-guide-to-scala-part-6-error-handling-with-try.html),
and [`Future`](http://danielwestheide.com/blog/2013/01/09/the-neophytes-guide-to-scala-part-8-welcome-to-the-future.html)
abstractions.
## Setup
```bash
$ npm install monapt
```
## APIs
### Usage
```typescript
import { Option } from 'monapt';
Option(1)
.map((x) => x * 2)
.getOrElse(() => 4);
```
Docs are undergoing a redesign, and will be published on a separate site.
In the meantime, the sources for the [`Option`](https://github.com/jiaweihli/monapt/tree/master/src/option),
[`Future`](https://github.com/jiaweihli/monapt/tree/master/src/future), and
[`Try`](https://github.com/jiaweihli/monapt/tree/master/src/try) classes are readable.
You can also take a look at the [tests](https://github.com/jiaweihli/monapt/tree/master/test) to get
a feel for how to use them.
## Changes in 1.0
1.0 was a complete rewrite of Monapt - including everything from the implementation to the tooling
to the tests. The result is almost the same API, but more true to the original Scala interface.
## Migrating from 0.7.1
### Breaking Changes
- All default exports have been removed [to avoid ambiguity](https://github.com/palantir/tslint/issues/1182#issue-151780453).
- `Future` now depends on native ES6 Promises, and uses them internally when representing promises. Make sure to
include a shim if you plan on using Futures.
- `Future#onFailure` has been removed.
- `Future#onSuccess` has been removed.
- `Future#reject` has been removed.
- `Monapt::flatten` has been renamed to `Option::flatten`.
- `Monapt::future` has been renamed to `Future::create`. It now accepts a
`when.Promise | when.Thenable | A`.
- `Option#reject` has been renamed to `Option#filterNot`.
- `Try#reject` has been removed.
These are all backed by type definitions, so compiling your code via TypeScript should reveal any
breakages.
## Credits
This repo couldn't have been possible without [yaakaito/monapt](https://github.com/yaakaito/monapt).
In his absence, I'll continue improving upon his hard work.