/lazyfunk-js

Lazy functional programming for ES6 generators and iterators.

Primary LanguageJavaScriptMIT LicenseMIT

lazyfunk

Lazy functional programming for ES6 generators and iterators.

1. [Quick start](#quick-start)
2. [Usage guide](#usage-guide)
3. [API reference](#api-reference)
4. [Building and testing](#building-and-testing)
5. [Compatibility](#compatibility)
6. [Roadmap](#roadmap)
7. [Changelog](#changelog)
8. [License](#license)

Quick start

.....

Usage guide

...

API reference

lazyfunk publishes a single namespace, lazyfunk, either on window or as module.exports for commonjs-style environments.

lazyfunk.method

...

Building and testing

You can run the automated test suite:

$ npm test

And build a minified version of the source:

$ npm run build

Don't forget the docs:

$ npm run docs

More tasks are available on the Makefile:

build ......... builds regular and minified distributables.
build-watch ... rebuilds on file change.
lint .......... lints the source.
test .......... runs the unit tests.
test-watch..... re-runs the tests on file change.
coverage ...... produces the code coverage reports.
docs .......... compiles the docs from the sources.
clean ......... removes the built artifacts.

Compatibility

...

Roadmap

...

Changelog

v0.1.0

  • Initial version

Full changelog

License

The MIT License (MIT)

Copyright (c) 2014, zenoamaro zenoamaro@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.