🚧 Rewrite

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm install
+    - run: npm run build
+    - run: npm test

.gitignore

@@ -1,3 +1,2 @@
 node_modules
-.vscode
-dist
+dist

.prettierignore

@@ -0,0 +1,2 @@
+# Ignore artifacts:
+dist

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true
+
+}

CHANGELOG

@@ -0,0 +1,15 @@
+# Changelog
+
+## [Unreleased] - 2024-05-03
+
+### Added
+- Changelog
+- Tests
+- ExpressJS demo
+- Basic healthz functionality
+- HTML and JSON preview
+- Build & minification with esbuild
+- GitHub actions
+
+### Removed
+- Everything

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jiri Smolik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README

@@ -0,0 +1,45 @@
+# node-healthz
+
+The "health-checkup" npm package simplifies the process of implementing health checks in Node.js applications, allowing you to ensure the reliability and availability of your system components effortlessly.
+
+```ts
+import { check } from 'node-healthz'
+check({
+  checks: [
+    {
+      id: 'PostgreSQL',
+      required: true,
+      fn: async () => /* ... */,
+    },
+    {
+      id: 'Redis',
+      fn: async () => /* ... */,
+    },
+  ],
+})
+```
+```
+curl http://localhost:46461/healthz --verbose | jq
+< HTTP/1.1 200 OK
+{
+  "status": "OK",
+  "checks": [
+    {
+      "id": "PostgreSQL",
+      "required": "true",
+      "t": "1,003ms",
+      "output": "<masked>"
+    },
+    {
+      "id": "Redis",
+      "required": "false",
+      "t": "11ms",
+      "output": "<masked>"
+    }
+  ]
+}
+```
+
+### Guides
+
+- [How to use with ExpressJS](./demo/express.ts)