# @types/karma-parallel

> TypeScript definitions for karma-parallel

Latest version **0.3.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/karma-parallel
pnpm add @types/karma-parallel
yarn add @types/karma-parallel
bun add @types/karma-parallel
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.4 |
| Published | 2023-11-07 |
| First published | 2020-03-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51437 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/karma-parallel
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/karma-parallel
- npm.io page: https://npm.io/package/@types/karma-parallel

## Dependencies (1)

- [@types/karma](https://npm.io/package/@types/karma.md) *

## Recent versions

- 0.3.4 (latest) — 2023-11-07
- 0.3.1 (ts3.6) — 2021-07-08
- 0.3.0 (ts3.2) — 2020-03-13
- 0.3.3 — 2023-10-18
- 0.3.2 — 2023-09-14

## README

# Installation
> `npm install --save @types/karma-parallel`

# Summary
This package contains type definitions for karma-parallel (https://github.com/joeljeske/karma-parallel#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/karma-parallel.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/karma-parallel/index.d.ts)
````ts
import "karma";

declare module "karma" {
    interface ConfigOptions {
        /**
         * Options for this plugin
         * see {@link https://github.com/joeljeske/karma-parallel#options}
         */
        parallelOptions?: ParallelOptions | undefined;
    }
    interface ParallelOptions {
        /**
         * regex or function used to determine if a reporter needs to only received aggregated events from the browser shards.
         * It is used to ensure coverage reporting is accurate amongst all the shards of a browser
         *  It is also useful for some programmatic reporters such as junit reporters that need to operate on a single set of test outputs and not once for each shard.
         * Set to null to disable aggregated reporting
         */
        aggregatedReporterTest?: ((reporter: object) => boolean) | RegExp | null | undefined;
        /**
         * The number of browser instances to use to test.
         * If you test on multiple types of browsers, this spin up the number of executors for each browser type
         * @default cpu_cores-1
         */
        executors?: number | undefined;
        /**
         * This plugin works by overriding the test suite describe() function.
         * When it encounters a describe, it must decide if it will skip the tests inside of it, or not
         * @default 'round-robin'
         */
        shardStrategy?: "round-robin" | "description-length" | "custom" | undefined;
        /**
         * Custom function that will determine if a describe block should run in the current executor.
         * It is a function that is serialized and re-constructed on each executor.
         * The function will be called for every top level describe block and should return true if the describe block should run for a the current executor
         */
        customShardStrategy?: ((options: ShardStrategOptions) => boolean) | undefined;
    }

    interface ShardStrategOptions {
        /**
         * the total number of executors
         */
        readonly executors: number;
        /**
         * the 0-based index of the current executor
         */
        readonly shardIndex: number;
        /**
         * the string passed to the describe block (useful for gaining context of the current description)
         */
        readonly description: string;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: [@types/karma](https://npmjs.com/package/@types/karma)

# Credits
These definitions were written by [Piotr Błażejewicz (Peter Blazejewicz)](https://github.com/peterblazejewicz).

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