Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/origamitower/folktale

[not actively maintained!] A standard library for functional programming in JavaScript
https://github.com/origamitower/folktale

algebraic-data-types functional javascript

Last synced: about 1 month ago
JSON representation

[not actively maintained!] A standard library for functional programming in JavaScript

Awesome Lists containing this project

README

        

Folktale
=======

[![Chat on Gitter](https://img.shields.io/gitter/room/folktale/discussion.svg?style=flat-square)](https://gitter.im/folktale/discussion)
[![NPM version](https://img.shields.io/npm/v/folktale.svg?style=flat-square)](https://npmjs.org/package/folktale)
![Licence](https://img.shields.io/npm/l/folktale.svg?style=flat-square&label=licence)

> **NOTE**: This package is not actively maintained anymore, because the
> maintainer stopped working with JavaScript. If you use this
> library and would like to take over maintaining it, reach out to
> [@robotlolita](https://twitter.com/robotlolita) on Twitter.

Folktale is a standard library for functional programming in JavaScript.

## Installing

Folktale can be installed through [npm][]:

$ npm install folktale

> Not using Node.js? [Check out our guide to running Folktale in other environments!][install]

## Documentation

- [Browse the HTML documentation for Folktale](http://origamitower.github.io/folktale)

> If you find any functionality that's not documented, or whose documentation
> is confusing or hard to understand, please [report a bug on our issue tracker][bug]

## Supported platforms

Folktale is written for ECMAScript 2015 platforms, but it uses a subset of features that can
be safely backported to platforms as old as ECMAScript 3. If you're running your program in
an older platform, you'll need [es5-shim][] and [es6-shim][].

[es5-shim]: https://github.com/es-shims/es5-shim
[es6-shim]: https://github.com/es-shims/es6-shim

- Node 4.x, Node 6+ ([**Node 5.x is not supported**](https://github.com/origamitower/folktale/issues/47))

**Browsers**:
- Chrome 36+
- Firefox 21+
- Safari 6+
- Internet Explorer 9+
- Edge 13+
- Opera 12.12+

**Mobile browsers**:
- Android 4.4+
- iOS 8.3+

## Support

> Note that all interactions in this project are subject to Origami Tower's
> [Code of Conduct](http://origamitower.github.io/folktale/coc/).

##### Having trouble using Folktale?

- ["I think I found a bug in Folktale"][bug]
- ["There's no documentation for X" / "The docs are hard to understand"][docs]
- [See the Frequently Asked Questions for common issues][faq]
- [Join the discussion channel][gitter]

##### Think Folktale should do something it doesn't yet?

- [I want to propose a new feature][feat]
- [I want to submit a patch/pull request][pr]

> By submitting a Pull Request you agree with releasing your code under the MIT licence.

##### Folktale discussion channels and information

- [Discussion channel @ Gitter][gitter]
- [Follow @origamitower for news on Folktale](https://twitter.com/OrigamiTower)
- [Email the organisation directly](mailto:[email protected])

## Licence

Folktale is copyright (c) Quildreen Motta 2015-2017, and released under the MIT licence.
See the `LICENCE` file in this repository for detailed information.

[npm]: https://www.npmjs.com
[bug]: http://origamitower.github.io/folktale/docs/support/bugs/
[docs]: http://origamitower.github.io/folktale/docs/support/bugs/#reporting-problems-in-the-documentation
[gitter]: https://gitter.im/folktale/discussion
[install]: http://origamitower.github.io/folktale/docs/v2.0.0/download/
[faq]: http://origamitower.github.io/folktale/docs/support/faq/
[feat]: http://origamitower.github.io/folktale/docs/support/feature-request/
[pr]: http://origamitower.github.io/folktale/docs/v2.0.0/contributing/