feat!: complete refactor

.github/workflows/ci.yml

@@ -2,11 +2,11 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [14.x, 16.x, 18.x]
+        node: [16.x, 18.x, 19.x]
     name: Node ${{ matrix.node }}
     steps:
       - uses: actions/checkout@v1

.github/workflows/pre-release.yml

@@ -6,7 +6,7 @@ on:
       - 'v*.*.*-rc**'
 
 jobs:
-  build:
+  release:
     runs-on: ubuntu-latest
     permissions:
       contents: write

.github/workflows/release.yml

@@ -5,7 +5,7 @@ on:
       - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
-  build:
+  release:
     runs-on: ubuntu-latest
     permissions:
       contents: write

exampleConfig.js

@@ -22,4 +22,4 @@ module.exports = {
   },
   // optional default resources if not specified in command args
   resources: ['http://foo/bar', 'http://cat/dog']
-};
+}

examples/http.js

@@ -0,0 +1,9 @@
+const { WaitOn } = require('..')
+
+WaitOn({
+  resources: ['http://localhost:3000'],
+  timeout: 10000,
+  events: {
+    onResourceResponse: console.log
+  }
+}).then(res => console.log('done:', res), console.error)

examples/socket.js

@@ -0,0 +1,9 @@
+const { WaitOn } = require('..')
+
+WaitOn({
+  resources: ['socket:/path/to/socket.sock'],
+  timeout: 10000,
+  events: {
+    onResourceResponse: console.log
+  }
+}).then(res => console.log('done:', res), console.error)

examples/tcp.js

@@ -0,0 +1,9 @@
+const { WaitOn } = require('..')
+
+WaitOn({
+  resources: ['tcp://localhost:3000'],
+  timeout: 10000,
+  events: {
+    onResourceResponse: console.log
+  }
+}).then(res => console.log('done:', res), console.error)

index.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+import { AgentOptions as HTTPAgentOptions } from "node:http";
+import { AgentOptions as HTTPSAgentOptions } from "node:https";
+
+declare function WaitOn(
+  options: WaitOnOptions,
+  cb?: WaitOnCallback
+): Promise<void> | void;
+
+type WaitOnCallback = (err?: Error) => unknown;
+
+type WaitOnProxyConfig = {
+  host?: string;
+  protocol?: string;
+  auth?: WaitOnOptions["auth"];
+};
+
+type WaitOnResourcesType =
+  | `file:${string}`
+  | `http-get:${string}`
+  | `https-get:${string}`
+  | `http:${string}`
+  | `https:${string}`
+  | `tcp:${string}`
+  | `socket:${string}`;
+
+type WaitOnValidateStatusCallback = (status: number) => boolean;
+
+type WaitOnOptions = {
+  resources: WaitOnResourcesType[];
+  delay?: number;
+  interval?: number;
+  log?: boolean;
+  reverse?: boolean;
+  simultaneous?: number;
+  timeout?: number;
+  tcpTimeout?: number;
+  verbose?: boolean;
+  window?: number;
+  passphrase?: string;
+  proxy?: boolean | WaitOnProxyConfig;
+  auth?: {
+    user: string;
+    pass: string;
+  };
+  headers?: Record<string, string | number>;
+  validateStatus?: WaitOnValidateStatusCallback;
+  strictSSL?: boolean;
+} & HTTPAgentOptions &
+  HTTPSAgentOptions;
+
+export default WaitOn;
+export {
+  WaitOnOptions,
+  WaitOnProxyConfig,
+  WaitOnResourcesType,
+  WaitOnValidateStatusCallback,
+  WaitOnCallback,
+  WaitOn,
+};