https://github.com/fpapado/elmlike
Functional utilities for types and data, inspired by Elm.
https://github.com/fpapado/elmlike
Last synced: about 1 month ago
JSON representation
Functional utilities for types and data, inspired by Elm.
- Host: GitHub
- URL: https://github.com/fpapado/elmlike
- Owner: fpapado
- License: mit
- Created: 2018-09-29T11:05:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-30T18:26:33.000Z (over 7 years ago)
- Last Synced: 2025-02-09T11:17:02.662Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 75.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Elmlike
> Functional utilities for types and data, inspired by Elm.
[](https://www.npmjs.com/package/elmlike)
[](https://bundlephobia.com/result?p=elmlike)
[](https://www.npmjs.com/package/elmlike)
[](https://david-dm.org/fpapado/elmlike)
## Table of Contents
- [Features](#features)
- [Install](#install)
- [Motivation](#motivation)
- [Usage](#usage)
- [Examples](#examples)
- [API Reference](#api-reference)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Thanks](#thanks-and-inspiration)
- [License](#license)
## Features
## Install
This package is distributed via [npm](https://www.npmjs.com/get-npm).
```shell
$ npm install --save elmlike
# or
$ yarn add elmlike
```
Then import according to your modules model and bundler, such as [Rollup](https://rollupjs.org/guide/en) and [Webpack](https://webpack.js.org/):
```js
// 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](https://github.com/umdjs/umd) version is also available on [unpkg](https://unpkg.com/):
```html
```
## 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:
```js
// TODO :)
```
## Examples
TODO: Write about common patterns, imports and so on
## API Reference
## Roadmap
## Contributing
## Thanks and Inspiration
## License
MIT License © Fotis Papadogeorgopoulos