# stryker-api

> The api for the extendable JavaScript mutation testing framework Stryker

Latest version **0.24.1** (published 2019-02-12) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install stryker-api
pnpm add stryker-api
yarn add stryker-api
bun add stryker-api
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.24.1 |
| Published | 2019-02-12 |
| First published | 2016-06-09 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 1 |
| Unpacked size | 99.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3165 |
| Maintainers | nicojs, simondel, strykermutator-npa |
| Keywords | mutation testing, mutation, testing, test, js, stryker |

## Links

- npm: https://www.npmjs.com/package/stryker-api
- Repository: https://github.com/stryker-mutator/stryker
- Homepage: https://github.com/stryker-mutator/stryker/tree/master/packages/stryker-api#readme
- Issues: https://github.com/stryker-mutator/stryker/issues
- npm.io page: https://npm.io/package/stryker-api

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ~1.9.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.24.1 (latest) — 2019-02-12
- 0.5.0-2 (next) — 2017-03-23
- 0.24.0 — 2019-02-08
- 0.23.0 — 2018-12-23
- 0.22.1 — 2018-12-12
- 0.22.0 — 2018-11-29
- 0.21.5 — 2018-11-13
- 0.21.4 — 2018-10-15
- 0.21.3 — 2018-10-15
- 0.21.2 — 2018-10-03
- 0.21.1 — 2018-09-14
- 0.21.0 — 2018-08-21
- 0.20.0 — 2018-08-19
- 0.19.0 — 2018-08-17
- 0.18.0 — 2018-07-20
- … 48 more at https://npm.io/package/stryker-api/versions

## README

[![Build Status](https://travis-ci.org/stryker-mutator/stryker.svg?branch=master)](https://travis-ci.org/stryker-mutator/stryker)
[![Gitter](https://badges.gitter.im/stryker-mutator/stryker.svg)](https://gitter.im/stryker-mutator/stryker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

![Stryker](https://github.com/stryker-mutator/stryker/raw/master/stryker-80x80.png)

# Stryker API
This is the repository for maintaining the API of the [Stryker](https://stryker-mutator.io) JavaScript mutation testing framework.
Plugin creators should depend on this API rather than on the main Stryker repository directly.

# Extension use cases
You can extend Stryker in a number of ways.

1. Create your own `Mutator`
2. Create a custom `Reporter`
3. Create a `TestFramework` for a test framework
4. Create a `TestRunner` to bridge the gap between your test runner and Stryker
5. Create a custom way of configuring Stryker by creating a `ConfigEditor` 

All extension points work in the same basic way. 

1. Create a `constructor function` (or `class`)
2. Register the `constructor function` to the correct `Factory`.

More info comming soon. In the mean time, take a look at the [Stryker homepage](https://stryker-mutator.io).

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