# @types/loopbench

> TypeScript definitions for loopbench

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

## Install

```sh
npm install @types/loopbench
pnpm add @types/loopbench
yarn add @types/loopbench
bun add @types/loopbench
```

## 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.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2023-11-07 |
| First published | 2019-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.2.4 (latest) — 2023-11-07
- 1.2.2 (ts4.3) — 2023-08-30
- 1.2.1 (ts3.6) — 2021-07-08
- 1.2.0 (ts2.0) — 2019-01-14
- 1.2.3 — 2023-10-18

## README

# Installation
> `npm install --save @types/loopbench`

# Summary
This package contains type definitions for loopbench (https://github.com/mcollina/loopbench#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/loopbench.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/loopbench/index.d.ts)
````ts
/// <reference types="node" />

import { EventEmitter } from "events";

export = loopbench;

/**
 * Creates a new instance of loopbench.
 */
declare function loopbench(options?: loopbench.Options): loopbench.LoopBench;

declare namespace loopbench {
    interface Options {
        /**
         * The interval at which the eventLoop should be sampled, defaults to `5`.
         */
        sampleInterval?: number | undefined;
        /**
         * The maximum amount of delay that is tolerated before `overLimit` becomes true,
         * and the `load` event is emitted, defaults to `42`.
         */
        limit?: number | undefined;
    }

    /**
     * Events:
     * - `load`, emitted when `instance.delay > instance.limit`
     * - `unload`, emitted when `overLimit` goes from `true` and `false`
     */
    interface LoopBench extends EventEmitter {
        /**
         * The delay in milliseconds (and fractions) from the expected run. It might be negative (in older nodes).
         */
        readonly delay: number;

        /**
         * The maximum amount of delay that is tolerated before `overLimit` becomes true,
         * and the `load` event is emitted.
         */
        readonly limit: number;

        /**
         * Is `true` if the `instance.delay > instance.limit`.
         */
        readonly overLimit: boolean;

        /**
         * Stops the sampling.
         */
        stop(): void;

        addListener(event: "load" | "unload", listener: () => void): this;
        on(event: "load" | "unload", listener: () => void): this;
        once(event: "load" | "unload", listener: () => void): this;
        removeListener(event: "load" | "unload", listener: () => void): this;
        off(event: "load" | "unload", listener: () => void): this;
        removeAllListeners(event?: "load" | "unload"): this;
        listeners(event: "load" | "unload"): Array<() => void>;
        rawListeners(event: "load" | "unload"): Array<() => void>;
        emit(event: "load" | "unload"): boolean;
        listenerCount(type: "load" | "unload"): number;
        prependListener(event: "load" | "unload", listener: () => void): this;
        prependOnceListener(event: "load" | "unload", listener: () => void): this;
        eventNames(): Array<"load" | "unload">;
    }
}

````

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

# Credits
These definitions were written by [BendingBender](https://github.com/BendingBender).

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