itbl - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
@@ -1,2 +0,2 @@ | ||
| # <a href="http://harrysarson.magic.net/">Harry Sarson</a> <span>v1.0.0</span> | ||
| # <a href="https://github.com/HarrySarson/itbl">itbl</a> <span>v1.0.1</span> | ||
@@ -37,3 +37,3 @@ <!-- div class="toc-container" --> | ||
| <h3 id="itblwrapper"><code>itbl.Wrapper()</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L98 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L98 "View in source") [Ⓣ][1] | ||
@@ -52,3 +52,3 @@ Base class with prototype containing chained itbl methods. | ||
| <h3 id="itblcombinecollection-finishearly"><code>itbl.combine(collection, [finish='early'])</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L464 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L464 "View in source") [Ⓣ][1] | ||
@@ -120,3 +120,3 @@ Combines the iterables in `collection` into a single iterable containing collections | ||
| <h3 id="itblfilteriterable-predicate_identity"><code>itbl.filter(iterable, [predicate=_.identity])</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L612 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L612 "View in source") [Ⓣ][1] | ||
@@ -171,3 +171,3 @@ Creates a new iterable containing values which the `predicate` returns truthy for. | ||
| <h3 id="itblfinalvalueiterable"><code>itbl.finalValue(iterable)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L668 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L668 "View in source") [Ⓣ][1] | ||
@@ -203,3 +203,3 @@ Gets and iterator from `iterable` and increments an iterator until | ||
| <h3 id="itblgetiteratoriterable"><code>itbl.getIterator([iterable=[]])</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L388 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L388 "View in source") [Ⓣ][1] | ||
@@ -237,3 +237,3 @@ Gets iterator from `iterable`. In `es6` environments using default value of `itbl.iteratorSymbol` when | ||
| <h3 id="itblisiterablevalue"><code>itbl.isIterable(value)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L239 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L239 "View in source") [Ⓣ][1] | ||
@@ -283,3 +283,3 @@ Checks if `value` is an iterable objectaccording to es6 iterator protocols. | ||
| <h3 id="itblisiteratorvalue"><code>itbl.isIterator(value)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L280 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L280 "View in source") [Ⓣ][1] | ||
@@ -328,3 +328,3 @@ Checks if `value` is an iterator according to es6 iterator protocols. | ||
| <h3 id="itbliteratorsymbol"><code>itbl.iteratorSymbol()</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L68 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L68 "View in source") [Ⓣ][1] | ||
@@ -345,3 +345,3 @@ Symbol or string used by libary to access iterator method, | ||
| <h3 id="itblmapiterable-iteratee_identity"><code>itbl.map(iterable, [iteratee=_.identity])</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L720 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L720 "View in source") [Ⓣ][1] | ||
@@ -388,3 +388,3 @@ Creates a new iterable whose iterators will have values coresponding to the value | ||
| <h3 id="itblnativeiterators"><code>itbl.nativeIterators()</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L39 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L39 "View in source") [Ⓣ][1] | ||
@@ -402,3 +402,3 @@ Read only boolean value indicating whether es6 iterators are supported. | ||
| <h3 id="itbltoarrayiterable"><code>itbl.toArray(iterable)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L779 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L779 "View in source") [Ⓣ][1] | ||
@@ -441,3 +441,3 @@ Iterates over `iterable` and creates an array containing the values contained | ||
| <h3 id="itblwrapvalue"><code>itbl.wrap(value)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L320 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L320 "View in source") [Ⓣ][1] | ||
@@ -486,3 +486,3 @@ Wraps an iterable, iterator, generator function (any function | ||
| <h3 id="itblwrapiterableiterable"><code>itbl.wrapIterable(iterable)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L157 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L157 "View in source") [Ⓣ][1] | ||
@@ -507,3 +507,3 @@ Wraps an iterable, adding chainable itbl methods. | ||
| <h3 id="itblwrapiteratoriterator"><code>itbl.wrapIterator(iterator)</code></h3> | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/blob/1.0.0/itbl.js#L122 "View in source") [Ⓣ][1] | ||
| [Ⓢ](https://github.com/HarrySarson/itbl/tree/v1.0.1/itbl.js#L122 "View in source") [Ⓣ][1] | ||
@@ -510,0 +510,0 @@ Wraps an iterator, adding chainable itbl methods. |
@@ -14,5 +14,5 @@ 'use strict'; | ||
| 'base': { | ||
| 'title': `<a href="http://harrysarson.magic.net/">Harry Sarson</a> <span>v${ version }</span>`, | ||
| 'title': `<a href="https://github.com/HarrySarson/itbl">itbl</a> <span>${ version }</span>`, | ||
| 'toc': 'categories', | ||
| 'url': `https://github.com/HarrySarson/itbl/blob/${ version }/itbl.js` | ||
| 'url': `https://github.com/HarrySarson/itbl/tree/${ version }/itbl.js` | ||
| }, | ||
@@ -19,0 +19,0 @@ 'github': { |
| { | ||
| "name": "itbl", | ||
| "version": "v1.0.0", | ||
| "version": "v1.0.1", | ||
| "description": "Utility libary so es6 style iterators inspired by lodash", | ||
@@ -5,0 +5,0 @@ "main": "itbl.js", |
| # itbl | ||
| Collection of javascript functions which unlock the potential of es6 iterators | ||
| A collection of javascript utility functions designed to unlock the full potential of [the es6 iterable protocol.](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Iteration_protocols) | ||
| The libary will run in es5 environments and supports poly/ponyfilled implementations of iterators. | ||
| * [**API Documentation**](/HarrySarson/itbl/blob/master/docs) | ||
| * [**View on npm**](https://www.npmjs.com/package/itbl) | ||
| ## Getting Started | ||
| To install with npm | ||
| ```sh | ||
| $ npm install itbl | ||
| ``` | ||
| Then using [Node.js](https://nodejs.org) or [Browserify](http://browserify.org). | ||
| ```js | ||
| // Load the full build. | ||
| let itbl = require('itbl'); | ||
| // Load indevidual methods | ||
| var map = require('itbl/map'); | ||
| var wrap = require('itbl/wrap'); | ||
| ``` | ||
| ### Dependancies | ||
| The libary current has [lodash](https://lodash.com) as a dependancy. In [Node.js](https://nodejs.org) or [Browserify](http://browserify.org) make sure lodash is installed as a dependancy of your project. | ||
| ```ah | ||
| $ npm install lodash | ||
| ``` | ||
| ## Built With | ||
| * [gulp](http://gulpjs.com) | ||
| * [docdown](https://github.com/jdalton/docdown) | ||
| ## Contributing | ||
| Contributions are welcome, style guide has not been written yet but will look very similar to [lodash's contributing guidelines](https://github.com/lodash/lodash/blob/master/.github/CONTRIBUTING.md). | ||
| ## Versioning | ||
| We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](tags). | ||
| ## Authors | ||
| * [**Harry Sarson**](https://github.com/HarrySarson) - *Initial work* | ||
| ## License | ||
| This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details | ||
| ## Acknowledgments | ||
| * This libary was inspired by [lodash](https://lodash.com) and the documentation style was heavily influenced by the documentation of lodash. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Manifest confusion
Supply chain riskThis package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.22%
82212
- Number of lines in readme file
- increased by2066.67%
65