elmlike v0.2.0

Elmlike

Functional utilities for types and data, inspired by Elm.

Table of Contents

• Features
• Install
• Motivation
• Usage
• Examples
• API Reference
• Roadmap
• Contributing
• Thanks
• License

Features

Install

This package is distributed via npm.

$ npm install --save elmlike
# or
$ yarn add elmlike

Then import according to your modules model and bundler, such as Rollup and Webpack:

// ES Modules
// For all possible functions to import look at the documentation
import * as Maybe from "elmlike/maybe";

/// CommonJS modules
const Maybe = require("elmlike/maybe");

A UMD version is also available on unpkg:

<script src="https://unpkg.com/elmlike/dist/elmlike.umd.js"></script>

Motivation

I love Elm's types and their API. I like that they are concrete, and easy to grasp, with a minimal API surface. I often write similar ad-hoc types when working in JS, and wanted a common point for them.

Usage

Quick Start

If you want to just dive in, do this:

// TODO :)

Examples

TODO: Write about common patterns, imports and so on

API Reference

Roadmap

Contributing

Thanks and Inspiration

License

MIT License © Fotis Papadogeorgopoulos