Skip to content
/ monapt Public
forked from jklmli/monapt

Options, Tries, and Futures for JavaScript/TypeScript

Notifications You must be signed in to change notification settings

bloom/monapt

 
 

Repository files navigation

Monapt

npm version Build Status Coverage Status

semantic-release Commitizen friendly Conventional Commits

Monapt helps you better manage null, undefined, exceptions, and other mildly interesting phenomena. It handles them through the Option, Try, and Future abstractions.

Setup

$ npm install monapt

APIs

Usage

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, Future, and Try classes are readable.

You can also take a look at the tests 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.
  • Future now depends on when.Promise, and uses it internally when representing promises.
  • 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<A> | when.Thenable<A> | 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. In his absence, I'll continue improving upon his hard work.

About

Options, Tries, and Futures for JavaScript/TypeScript

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.8%
  • JavaScript 4.2%