@types/user-idle-observer v1.0.3

Installation

npm install --save @types/user-idle-observer

Summary

This package contains type definitions for user-idle-observer (https://github.com/vladagurets/user-idle-observer#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/user-idle-observer.

index.d.ts

// Type definitions for user-idle-observer 1.0
// Project: https://github.com/vladagurets/user-idle-observer#readme
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export as namespace userIDLEObserver;

/**
 * This lib allows you to track user inactivity time.
 */
declare function userIDLEObserver(opts?: userIDLEObserver.Options): userIDLEObserver.UserIDLEObserver;

declare namespace userIDLEObserver {
    /**
     * observer options
     */
    interface Options {
        /**
         * fire callback on user inactivity time in ms
         * @default 3_000
         */
        idleTime?: number | undefined;
        /**
         * callback that will triger after opts.idleTime of user's IDLE
         * @default console.log
         */
        cb?: Callback | undefined;
        /**
         * @default ["mousemove", "mousedown", "keydown", "scroll", "touchstart", "resize", "visibilitychange"]
         */
        listeners?: Array<keyof WindowEventMap> | undefined;
    }

    interface UserIDLEObserver {
        /**
         * destroy observer instance
         */
        destroy(): void;
    }

    type Callback = (time: number) => void;
}

export = userIDLEObserver;

Additional Details

• Last updated: Fri, 02 Jul 2021 18:04:53 GMT
• Dependencies: none
• Global values: userIDLEObserver

Credits

These definitions were written by Piotr Błażejewicz.