Skip to content

Latest commit

 

History

History
94 lines (75 loc) · 2.43 KB

README.md

File metadata and controls

94 lines (75 loc) · 2.43 KB
Raw

sfuture

Build Status

JavaScript port of Scala Future written with TypeScript. See documentation for more information.

Compatibility

This library uses ES6 promise. So you need modern browser, io.js. If you want to use it with node.js, please ensure your node.js version is upper than 0.12.0. See ES6 compatibility table for more information.

How to use

With NPM

npm install sfuture

From source

Get source

git clone https://github.com/sgkim126/sfuture.git
cd sfuture

or

wget https://github.com/sgkim126/sfuture/archive/{version}.tar.gz
tar -xf {version}.tar.gz
cd {version}

Compile

make

Now you have {path to sfuture}/src/sfuture.js. Use it.

How to contribute

sfuture is written with TypeScript, checks style with tslint, runs tests with mocha and checks test coverage with istanbul. npm test command tests them all.

How to compile

There are two commands to compile. One is make build(or just make) it only compiles future.js with declaration file. Another is make all. It build future.js and build all tests.

How to lint

make lint

All configuration about lint is in .tslintrc.json

How to test

make test

How to check test coverage

Currently, sfuture ensures 100% test coverage.

make cover

How to generate document

make doc

Changelogs

Jul 05, 2015 - 1.0.0

  • Fix a bug on find function.
  • Use es6 promise instead of mpromise.
  • Any type can be reject reason.

Jun 29, 2015 - 0.6.0

  • Change the signature of transform method
  • Implement withFilter, fromTry,
  • Rename create to apply

Jun 28, 2015 - 0.5.0

  • Implement find, zip, recoverWith, foreach and fallbackTo

Jun 20, 2015 - 0.4.0

  • Implement firstCompletedOf, fold, reduce, traverse, and collect.

Jun 20, 2015 - 0.3.2

  • Publish only the compiled files

Jun 07, 2015 - 0.3.1

  • Change Future.sequence() signature to take an array of futures instead of rest parameters

Jun 03, 2015 - 0.2.0

  • Change onComplete method to use node style callback

Jun 01, 2015 - 0.1.0

  • Change onComplete signature

May 27, 2015 - 0.0.4

  • Implement some of methods