feat: define enums for isomorphic class

annexare · Aug 17, 2022 · 7e48e19 · 7e48e19
1 parent d8d86c0
commit 7e48e19
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 11 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/IdleDetect.ts b/src/IdleDetect.ts
@@ -17,12 +17,16 @@ export class IdleDetect {
   public error: (...messages: any[]) => void = defaultNoLog
   public log: (...messages: any[]) => void = defaultNoLog
 
+  /**
+   * @param idleSeconds Number of seconds for idle detection, 15 minutes by default
+   * @param onIdle Event handler when user is idle for specified time
+   * @param enableLogs
+   * @param eventTypes
+   */
   constructor(
-    /** Number of seconds for idle detection, 15 minutes by default */
     idleSeconds: number = defaultIdleTime,
-    /** Event handler when user is idle for specified time */
     onIdle: () => void = defaultNoop,
-    enableLogs = false,
+    enableLogs: boolean = false,
     eventTypes: string[] = defaultEventTypes,
   ) {
     this.eventTypes = eventTypes

diff --git a/src/IdleDetectIsomorph.ts b/src/IdleDetectIsomorph.ts
@@ -2,15 +2,29 @@ import { IdleDetect, defaultEventTypes, defaultIdleTime, defaultNoop } from './I
 
 export const isIdleDetectorSupported = () => 'IdleDetector' in window
 
+export enum UserIdleState {
+  active = 'active',
+  idle = 'idle',
+}
+
+export enum ScreenIdleState {
+  locked = 'locked',
+  unlocked = 'unlocked',
+}
+
 export class IdleDetectIsomorph extends IdleDetect {
   // Native API
   protected controller?: AbortController = null
   protected detector?: IdleDetector = null
 
+  /**
+   * @param idleSeconds Number of seconds for idle detection, 15 minutes by default
+   * @param onIdle Event handler when user is idle for specified time
+   * @param enableLogs
+   * @param eventTypes
+   */
   constructor(
-    /** Number of seconds for idle detection, 15 minutes by default */
     idleSeconds: number = defaultIdleTime,
-    /** Event handler when user is idle for specified time */
     onIdle: () => void = defaultNoop,
     enableLogs = false,
     eventTypes: string[] = defaultEventTypes,

diff --git a/src/global.d.ts b/src/global.d.ts
@@ -7,13 +7,13 @@
 
 declare global {
   enum UserIdleState {
-    'active' = 'active',
-    'idle' = 'idle',
+    active = 'active',
+    idle = 'idle',
   }
 
   enum ScreenIdleState {
-    'locked' = 'locked',
-    'unlocked' = 'unlocked',
+    locked = 'locked',
+    unlocked = 'unlocked',
   }
 
   interface IdleDetector {

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,5 @@
 import { IdleDetectIsomorph } from './IdleDetectIsomorph'
 
+export { UserIdleState, ScreenIdleState } from './IdleDetectIsomorph'
+
 export default IdleDetectIsomorph