# amocha

> Async wrapper for mocha

Latest version **7.1.2** (published 2021-03-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install amocha
pnpm add amocha
yarn add amocha
bun add amocha
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.1.2 |
| Published | 2021-03-08 |
| First published | 2016-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | mocha |

## Links

- npm: https://www.npmjs.com/package/amocha
- Repository: https://github.com/a-labo/amocha
- Homepage: https://github.com/a-labo/amocha#readme
- Issues: https://github.com/a-labo/amocha/issues
- npm.io page: https://npm.io/package/amocha

## Dependencies (3)

- [aglob](https://npm.io/package/aglob.md) ^3.0.2
- [mocha](https://npm.io/package/mocha.md) ^8.1.0
- [execcli](https://npm.io/package/execcli.md) ^5.0.6

## Recent versions

- 7.1.2 (latest) — 2021-03-08
- 7.1.1 — 2020-07-31
- 7.1.0 — 2020-06-11
- 7.0.2 — 2020-04-15
- 7.0.1 — 2020-01-19
- 6.0.0 — 2019-03-23
- 5.0.2 — 2019-03-05
- 5.0.1 — 2019-02-23
- 5.0.0 — 2018-01-28
- 4.0.0 — 2017-10-03
- 3.0.0 — 2017-09-17
- 2.0.0 — 2017-01-29
- 1.0.16 — 2016-10-20
- 1.0.15 — 2016-09-11
- 1.0.14 — 2016-08-13
- … 14 more at https://npm.io/package/amocha/versions

## README

amocha
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/a-labo/amocha
[bd_travis_url]: http://travis-ci.org/a-labo/amocha
[bd_travis_shield_url]: http://img.shields.io/travis/a-labo/amocha.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/a-labo/amocha
[bd_travis_com_shield_url]: https://api.travis-ci.com/a-labo/amocha.svg?token=
[bd_license_url]: https://github.com/a-labo/amocha/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/a-labo/amocha
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/a-labo/amocha.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/a-labo/amocha.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/a-labo/amocha
[bd_gemnasium_shield_url]: https://gemnasium.com/a-labo/amocha.svg
[bd_npm_url]: http://www.npmjs.org/package/amocha
[bd_npm_shield_url]: http://img.shields.io/npm/v/amocha.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Async wrapper for mocha

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install amocha --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const amocha = require('amocha')

;(async () => {
  // Run tests
  await amocha('test/**/*_test.js', {})

  // Measure coverage
  await amocha.coverage('test/**/*_test.js', {
    dir: 'coverage'
  })
}).catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Signature.md.hbs" Start -->

<a name="section-doc-guides-03-signature-md"></a>

Signature
---------

`amocha(pattern, options, reporter) -> Promise`

### Params

| Name | Type | Description |
| ----- | --- | -------- |
| pattern | string | Glob file name pattern |
| options | Object | Optional settings |
| reporter | string |  |
| options.cwd | string | Working directory path |
| options.reporter | string | Mocha reporter |
| options.timeout | number | Timeout duration |



<!-- Section from "doc/guides/03.Signature.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/a-labo/amocha/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------



<!-- Links End -->

---
_Source: https://npm.io/package/amocha · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._