@types/blocked-at/README.md

TypeScript definitions for blocked-at

# Installation
> `npm install --save @types/blocked-at`

# Summary
This package contains type definitions for blocked-at (https://github.com/naugtur/blocked-at#readme).

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

/*~ Note that ES6 modules cannot directly export callable functions.
 *~ This file should be imported using the CommonJS-style:
 *~   import x = require('someLibrary');
 *~
 *~ Refer to the documentation to understand common
 *~ workarounds for this limitation of ES6 modules.
 */

export = blockedAt;

declare function blockedAt(
    fn: (time: number, stack: string[], resource: blockedAt.Resource) => unknown,
    options?: blockedAt.Options,
): blockedAt.Return;

declare namespace blockedAt {
    interface Options {
        trimFalsePositives?: boolean | undefined;
        threshold?: number | undefined;
        resourcesCap?: number | undefined;
        debug?: boolean | undefined;
    }

    interface Resource {
        type: string;
        resource?: any;
    }

    interface Return {
        stop: () => void;
    }
}

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:04 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

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