Skip to content

Latest commit

 

History

History
161 lines (115 loc) · 6.62 KB

.verb.md

File metadata and controls

161 lines (115 loc) · 6.62 KB
Raw

{%= name %} {%= badge('npm') %} {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

{%= description %}

[![code climate][codeclimate-img]][codeclimate-url] standard code style [![linux build status][travis-img]][travis-url] [![windows build status][appveyor-img]][appveyor-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]

{%= include('highlight') %}

Table of Contents

Install

Install with npm

$ npm install {%= name %} --save

or install using yarn

$ yarn add {%= name %}

Usage

For more use-cases see the tests

const {%= varname %} = require('{%= name %}')

API

{%= apidocs('index.js') %}

Options

You have control over everything, through options.

  • Promise {Function}: custom Promise constructor to be used, defaults to native
  • mapper {Function}: function to apply to each item in iterable, see item section
  • settle {Boolean}: if false stops after first error (also known as "fail-fast" or "bail"), default true
  • flat {Boolean}: result array to contain only values, default true
  • concurrency {Number}: works only with .parallel method, defaults to iterable length
  • start {Function}: on start hook, see hooks section
  • beforeEach {Function}: called before each item in iterable, see hooks section
  • afterEach {Function}: called after each item in iterable, see hooks section
  • finish {Function}: called at the end of iteration, see hooks section

back to top

Hooks

You can do what you want between stages through hooks - start, before each, after each, finish.

  • start {Function}: called at the start of iteration, before anything
  • beforeEach {Function}: passed with item, index, arr arguments
    • item is an object with value, reason and index properties, see item section
    • index is the same as item.index
    • arr is the iterable object - array or object
  • afterEach {Function}: passed with item, index, arr arguments
    • item is an object with value, reason and index properties, see item section
    • index is the same as item.index
    • arr is the iterable object - array or object
  • finish {Function}: called at the end of iteration, see finish hook section

back to top

Item

That object is special object, that is passed to beforeEach and afterEach hooks, also can be found in result object if you pass opts.flat: false option. And passed to opts.mapper function too.

  • item.value resolved/rejected promise value, if at beforeEach hook it can be function
  • item.reason may not exist if item.value, if exist it is standard Error object
  • item.index is number, order of "executing", not the order that is defined in iterable

back to top

Finish hook

This hooks is called when everything is finished / completed. At the very end of iteration. It is passed with err, result arguments where:

  • err is an Error object, if opts.settle: false, otherwise null
  • result is always an array with values or item objects if opts.flat: false

back to top

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Related

{%= related(verb.related.list, {words: 20}) %} {% } %}

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

  1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
  3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
  4. Do NOT bump the version in package.json. For that we use npm run release, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run verb command like that

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

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

{%= includeEither('authors', 'author') %}

License

{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= license %}

{%= include('footer') %}

{%= reflinks(verb.reflinks) %}

[downloads-url]: https://www.npmjs.com/package/{%= name %} [downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg

[travis-url]: https://travis-ci.org/{%= repository %} [travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows

[coveralls-url]: https://coveralls.io/r/{%= repository %} [coveralls-img]: https://img.shields.io/coveralls/{%= repository %}.svg

[david-url]: https://david-dm.org/{%= repository %} [david-img]: https://img.shields.io/david/{%= repository %}.svg