Browse Source

[docs] Updated README

master
Muthu Kumar 7 years ago
parent
commit
d553205356
  1. 2
      .gitignore
  2. 17
      README.md

2
.gitignore

@ -1,6 +1,6 @@
# Test File # Test File
testscript.js testscript.js
jsdoc-template
# Logs # Logs
logs logs
*.log *.log

17
README.md

@ -5,9 +5,10 @@
## Usage ## Usage
### Fuse
```JavaScript ```JavaScript
const Fuse = require('@codefeathers/fuse'); const Fuse = require('@codefeathers/fuse');
const { FuseIterable } = require('@codefeathers/fuse');
const a = 100; const a = 100;
@ -19,11 +20,17 @@ const result = new Fuse(a)
.on(x => x===10, .on(x => x===10,
a => `${a} is 10.`) a => `${a} is 10.`)
console.log(result.resolve()); console.log(result.resolve()); // -> "100 is greater than 10."
```
### FuseIterable
```JavaScript
const { FuseIterable } = require('@codefeathers/fuse');
const arr = [ 0, 20, 30 ]; const temperatures = [ 0, 20, 30 ];
const temperature = new FuseIterable(arr) const result = new FuseIterable(temperatures)
.on(temp => temp<10, .on(temp => temp<10,
() => `Too cold!`) () => `Too cold!`)
.on(temp => temp>=10 && temp <25, .on(temp => temp>=10 && temp <25,
@ -31,7 +38,7 @@ const temperature = new FuseIterable(arr)
.on(temp => temp>=25, .on(temp => temp>=25,
() => `Too warm!`) () => `Too warm!`)
console.log(temperature.resolve()); // -> [ "Too cold!", "Just right.", "Too warm!" ] console.log(result.resolve()); // -> [ "Too cold!", "Just right.", "Too warm!" ]
``` ```
## Docs ## Docs

Loading…
Cancel
Save