Merge pull request #141 from bhsiao123/patch/typescript

Add missing JobMonitorOptions to ConstructorOptions

docs/configuration.md

@@ -7,6 +7,7 @@ pg-boss can be customized using configuration options when an instance is create
 
 - [Constructor Options](#constructor-options)
     - [Database options](#database-options)
+    - [Job monitor options](#job-monitor-options)
     - [Job creation options](#job-creation-options)
     - [Job fetch options](#job-fetch-options)
     - [Job expiration options](#job-expiration-options)
@@ -77,6 +78,8 @@ Since passing only a connection string is intended to be for convenience, you ca
 
     Only alphanumeric and underscore allowed, length: <= 50 characters
 
+### Job monitor options
+
 * **monitorStateIntervalSeconds** - int, default undefined
 
     Specifies how often in seconds an instance will fire the `monitor-states` event. Cannot be less than 1.

types.d.ts

@@ -20,6 +20,18 @@ declare namespace PgBoss {
     db?: Db;
   }
 
+  interface JobMonitorOptions {
+    /** 
+     * Specifies how often in seconds an instance will fire the monitor-states event. Cannot be less than 1. 
+    */
+    monitorStateIntervalSeconds?: number
+
+    /**
+     * Specifies how often in minutes an instance will fire the monitor-states event. Cannot be less than 1. Do not use if using monitorStateIntervalSeconds
+     */
+    monitorStateIntervalMinutes?: number
+  }
+
   interface JobCreationOptions {
     uuid?: "v1" | "v4";
   }
@@ -44,7 +56,7 @@ declare namespace PgBoss {
     deleteCheckInterval?: number;
   }
 
-  type ConstructorOptions = DatabaseOptions & JobCreationOptions & JobFetchOptions & JobExpirationOptions & JobArchiveOptions;
+  type ConstructorOptions = DatabaseOptions & JobMonitorOptions & JobCreationOptions & JobFetchOptions & JobExpirationOptions & JobArchiveOptions;
 
   interface PublishOptions {
     priority?: number;