site_opytex/theme/node_modules/make-iterator/README.md

4.2 KiB

make-iterator NPM version NPM monthly downloads NPM total downloads Linux Build Status

Convert an argument into a valid iterator. Based on the .makeIterator() implementation in mout https://github.com/mout/mout.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save make-iterator

Copyright (c) 2012, 2013 moutjs team and contributors (http://moutjs.com)

Usage

var iterator = require('make-iterator');

Regex

var arr = ['a', 'b', 'c', 'd', 'e', 'f'];
var fn = iterator(/[a-c]/);
console.log(arr.filter(fn));
//=> ['a', 'b', 'c'];

Objects

var fn =  iterator({ a: 1, b: { c: 2 } });

console.log(fn({ a: 1, b: { c: 2, d: 3 } }));
//=> true
console.log(fn({ a: 1, b: { c: 3 } }));
//=> false

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

You might also be interested in these projects:

  • any: Returns true if a value exists in the given string, array or object. | homepage
  • arr-filter: Faster alternative to javascript's native filter method. | homepage
  • arr-map: Faster, node.js focused alternative to JavaScript's native array map. | homepage
  • array-every: Returns true if the callback returns truthy for all elements in the given array. | homepage
  • collection-map: Returns an array of mapped values from an array or object. | homepage
  • utils: Fast, generic JavaScript/node.js utility functions. | homepage

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on April 08, 2018.