@types/pause-me/README.md

TypeScript definitions for pause-me

# Installation
> `npm install --save @types/pause-me`

# Summary
This package contains type definitions for pause-me (https://github.com/jpehman/pause-mejs#readme).

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

declare namespace pauseMe {
    interface PausableTimeout {
        start(): void;
        pause(): void;
        resume(): void;
        stop(): void;
        timer(): NodeJS.Timeout | null;
    }
}

/**
 * @param callback function or lambda that you want executed after duration
 * @param duration Milliseconds to set the timeout to
 * @param repeating When true the timeout is treated as an interval
 */
declare function pauseMe(callback: () => void, duration: number, repeating?: boolean): pauseMe.PausableTimeout;

export = pauseMe;

````

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

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