Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnhof/genit
Generator based utility belt
https://github.com/johnhof/genit
Last synced: 20 days ago
JSON representation
Generator based utility belt
- Host: GitHub
- URL: https://github.com/johnhof/genit
- Owner: johnhof
- License: mit
- Created: 2015-07-07T04:46:37.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-17T19:24:43.000Z (over 8 years ago)
- Last Synced: 2024-10-05T01:41:19.171Z (about 1 month ago)
- Language: JavaScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# genit
Generator based utility belt
[](https://travis-ci.org/fleekjs/genit) [](https://github.com/fleekjs/genit/blob/master/LICENSE) [](https://david-dm.org/fleekjs/genit) [](https://gitter.im/fleekjs/genit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
`$ npm install genit`
# Key
- [Usage](#usage)
- [Direct](#direct)
- [Module Extention](#moduleextension)
- [Utilities](#utilities)
- [Synchronous](#Synchronous)
- [Mixed](#mixed-synchronous)
- [each](#each)
- [map](#map)
- [Asynchronous](#Synchronous)
- _Coming Soon_
- [Miscellaneous](#miscellaneous)
- [isGenerator](#isgenerator)
- [inject](#inject)
# Usage
### Direct
```javascript
'use strict'
let genit = require('genit');
let fooFunc = function *(someSet) {
return yield genit.map(someSet, function *(value, index) {
return yield someGeneratorFunction('foo', 'bar', value);
});
}
```
### Module Extension
```javascript
'use strict'
let _ = require('lodash');
let genit = require('genit');
genit.inject(_);
_.each(someSet, function () { }); //existing
_.isGenerator(mightBeAGenerator) // injected
function *() {
return yield _.genit.map(someSet, function *(value, index) { }); // injected to .genit property (name collision)
}
```
# Utilities
## Synchronous
### Mixed Synchronous
#### `each`
- Parameters
- [Required] [Mixed] - Collection to operate on,
- [Required] [Generator Function] - Operation to perform
- Functionality
- Iterates over every item in the collection (objec tor array)
- Executes the operation on each item
- Returns
- Undefined
```javascript
yield genit.each([one, two, three], function *(value, index) {
console.log(index + ' = ' + this + ' ~ ' + value);
});
// console:
// 1 = one ~ one
// 2 = two ~ two
// 3 = three ~ three
yield genit.each({ one:'foo', two:'bar', three:'biz' }, function *(value, key) {
console.log(key + ' = ' + this + ' ~ ' + value);
});
// console:
// one = foo ~ foo
// two = bar ~ bar
// three = biz ~ biz
```
#### `map`
- Parameters
- [Required] [Mixed] - Collection to operate on,
- [Required] [Generator Function] - Operation to perform
- Functionality
- Iterates over every item in the collection (objec tor array)
- Executes the operation on each item
- Returned value is added to the resulting array
- Returns
- Array of values returned
```javascript
let result = yield genit.each(['one', 'two', 'three'], function *(value, index) {
console.log(index + ' = ' + this + ' ~ ' + value);
return index * 2;
});
// console:
// 1 = one ~ one
// 2 = two ~ two
// 3 = three ~ three
console.log(result);
// console:
// [0, 1, 2]
let result = yield genit.each({ one:'foo', two:'bar', three:'biz' }, function *(value, key) {
console.log(key + ' = ' + this + ' ~ ' + value);
return value;
});
// console:
// one = foo ~ foo
// two = bar ~ bar
// three = biz ~ biz
console.log(result);
// console:
// ['foo', 'bar', 'biz']
```
#### `filter`
- Parameters
- [Required] [Mixed] - Collection to operate on,
- [Required] [Generator Function] - Operation to perform
- Functionality
- Iterates over every item in the collection (object or array)
- Reserve only the item that passed the checking condition
- Returned value is added to the resulting array or object
- Returns
- Array or object values returned
```javascript
let result = yield genit.filter([-1, -2, -3, 4, 5], function *(value) {
return value > 0;
});
console.log(result);
// console:
// [4,5]
let result = yield genit.filter({ one:'foo', two:'bar', three:'biz' }, function *(value, key) {
return value == "biz" || value == "bar";
});
console.log(result);
// console:
// {two : 'bar', three: 'biz'}
```
## Asynchronous
**Coming Soon**
## Miscellaneous
#### `isGenerator`
- Parameters
- [Required] [Mixed] - object to type check
- Functionality
- Test whether or not a function is a generator
- Returns
- Boolean of generator status
```javascript
let result = yield genit.isGenerator(function () {});
console.log(result); // => false
let result = yield genit.isGenerator(function *() {});
console.log(result); // => true
```
#### `inject`
- Parameters
- [Required] [Object] - object to inject properties to
- Functionality
- Inject properties into target Object
- Collision in property name move genit property to the `.genit` property
- Returns
- target object with injected properties
```javascript
'use strict'
let test = { each : function () { return 'Original Each'; } };
let genit = require('genit');
genit.inject(test);
console.log(test.each()); // => "Original Each"
console.log(test.isGenerator(function () {})) // => "false"
console.log(test.isGenerator(test.genit.each)) // => "true"
```
# Authors
- John Hofrichter
- Contributor Lan Nguyen