feat: allow to customize the ping system

Closes #4

src/transmit.ts

@@ -8,6 +8,7 @@
  */
 
 import Emittery from 'emittery'
+import string from '@poppinss/utils/string'
 import { Stream } from './stream.js'
 import { StorageBag } from './storage_bag.js'
 import { SecureChannelStore } from './secure_channel_store.js'
@@ -69,7 +70,14 @@ export class Transmit {
       void this.#broadcastLocally(channel, payload)
     })
 
-    setInterval(() => this.#ping(), 1000 * 60)
+    if (this.#config.pingInterval) {
+      const intervalValue =
+        typeof this.#config.pingInterval === 'number'
+          ? this.#config.pingInterval
+          : string.milliseconds.parse(this.#config.pingInterval)
+
+      setInterval(() => this.#ping(), intervalValue)
+    }
   }
 
   /**

src/types/main.ts

@@ -7,12 +7,22 @@
  * file that was distributed with this source code.
  */
 
+/**
+ * A Duration can be a number in milliseconds or a string formatted as a duration
+ *
+ * Formats accepted are :
+ * - Simple number in milliseconds
+ * - String formatted as a duration. Uses https://github.com/lukeed/ms under the hood
+ */
+export type Duration = number | string
+
 export interface Transport {
   send(channel: string, payload: any): Promise<void>
   subscribe(channel: string, handler: any): Promise<void>
   unsubscribe(channel: string): Promise<void>
 }
 
 export interface TransmitConfig {
+  pingInterval?: Duration | false
   transport: null | { driver: new (...args: any[]) => Transport; channel?: string }
 }

stubs/config/transmit.stub

@@ -4,5 +4,6 @@
 import { defineConfig } from '@adonisjs/transmit'
 
 export default defineConfig({
+  pingInterval: false,
   transport: null
 })