fastify-healthcheck - npm Package Compare versions

Comparing version 4.2.0 to 4.3.0

CHANGELOG.md

 # Change Log
 
+## [4.3.0](https://github.com/smartiniOnGitHub/fastify-healthcheck/releases/tag/4.3.0) (2022-12-12)
+[Full Changelog](https://github.com/smartiniOnGitHub/fastify-healthcheck/compare/4.2.0...4.3.0)
+Summary Changelog:
+- Updated requirements to Fastify '^4.10.2' and under-pressure '^8.2.0'; 
+  updated all other dependencies to latest
+- Compatibility with TypeScript 4.9 and NodeNext / ESNext
+
 ## [4.2.0](https://github.com/smartiniOnGitHub/fastify-healthcheck/releases/tag/4.2.0) (2022-09-01)
@@ -4,0 +11,0 @@ [Full Changelog](https://github.com/smartiniOnGitHub/fastify-healthcheck/compare/4.1.0...4.2.0)

package.json

 {
   "name": "fastify-healthcheck",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Fastify Plugin to serve responses for health checks",
@@ -28,3 +28,5 @@ "main": "src/plugin",
     "lint:standard": "standard --verbose",
-    "lint:typescript": "eslint -c types/.eslintrc.json types/*.d.ts types/*.test-d.ts",
+    "lint:typescript": "standard --parser @typescript-eslint/parser --plugin @typescript-eslint/eslint-plugin test/*.ts",
+    "lint:typescript:eslint": "eslint -c types/.eslintrc.json types/*.d.ts types/*.test-d.ts",
+    "lint:typescript:eslint:fix": "eslint -c types/.eslintrc.json types/*.d.ts types/*.test-d.ts --fix",
     "lint": "npm run lint:standard && npm run lint:typescript",
@@ -42,14 +44,14 @@ "start": "node src/healthcheck",
   "dependencies": {
-    "@fastify/under-pressure": "^8.1.0"
+    "@fastify/under-pressure": "^8.2.0"
   },
   "devDependencies": {
-    "@types/node": "^18.7.14",
-    "@typescript-eslint/eslint-plugin": "^5.36.1",
-    "@typescript-eslint/parser": "^5.36.1",
-    "fastify": "^4.5.3",
-    "jsdoc": "^3.6.11",
+    "@types/node": "^18.11.13",
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
+    "fastify": "^4.10.2",
+    "jsdoc": "^4.0.0",
     "simple-get": "^4.0.1",
     "standard": "^17.0.0",
-    "tap": "^16.3.0",
-    "tsd": "^0.23.0"
+    "tap": "^16.3.2",
+    "tsd": "^0.25.0"
   },
@@ -56,0 +58,0 @@ "standard": {

README.md

@@ -89,3 +89,3 @@ # fastify-healthcheck
 
-Fastify ^4.5.3 , Node.js 14 LTS (14.15.0) or later.
+Fastify ^4.10.2 , Node.js 14 LTS (14.15.0) or later.
 Note that plugin releases 3.x are for Fastify 3.x, 4.x are for Fastify 4.x, etc.
@@ -92,0 +92,0 @@

types/index.d.ts

 /// <reference types="node" />
 
-import underPressure from '@fastify/under-pressure'
+import { UnderPressureOptions } from '@fastify/under-pressure'
+// import { FastifyInstance, FastifyPluginCallback, FastifyPluginOptions, FastifyRequest } from 'fastify'
 import { FastifyPluginCallback } from 'fastify'
 
-export interface FastifyHealthcheckOptions {
-  healthcheckUrl?: string
-  healthcheckUrlDisable?: boolean
-  healthcheckUrlAlwaysFail?: boolean
-  exposeUptime?: boolean
-  underPressureOptions?: underPressure.UnderPressureOptions
+// note that this plugin does not use FastifyPlugin, but it's good the same here for types
+
+type FastifyHealthcheckPlugin = FastifyPluginCallback<NonNullable<fastifyHealthcheck.FastifyHealthcheckOptions>>
+
+declare namespace fastifyHealthcheck {
+  export interface FastifyHealthcheckOptions {
+  /**
+   * Override the uri for the healthcheck route (default: '/health').
+   */
+    healthcheckUrl?: string
+
+    /**
+     * Disable the healthcheck route (default: false).
+     */
+    healthcheckUrlDisable?: boolean
+
+    /**
+     * Override to always return failure responses, useful to test failure responses (default: false).
+     */
+    healthcheckUrlAlwaysFail?: boolean
+
+    /**
+     * Override to return Node.js process uptime (default: false).
+     */
+    exposeUptime?: boolean
+
+    /**
+     * Override options for under-pressure (default: {}).
+     */
+    underPressureOptions?: UnderPressureOptions
+  }
+
+  export const fastifyHealthcheck: FastifyHealthcheckPlugin
+  export { fastifyHealthcheck as default }
 }
 
-declare const fastifyHealthcheck: FastifyPluginCallback<FastifyHealthcheckOptions>
-export default fastifyHealthcheck
+declare function fastifyHealthcheck(
+  ...params: Parameters<FastifyHealthcheckPlugin>
+): ReturnType<FastifyHealthcheckPlugin>
+
+export = fastifyHealthcheck

types/tsconfig.json

 {
   "compilerOptions": {
-    "target": "ES6",
-    "lib": [ "ES2015", "DOM" ],
+    "checkJs": false,
+    "esModuleInterop": true,
+    "lib": [ "ES2020", "DOM" ],
     "module": "commonjs",
+    "moduleResolution": "node",
     "noEmit": true,
+    "noImplicitAny": true,
+    "preserveConstEnums": true,
+    "sourceMap": false,
     "strict": true,
-    "esModuleInterop": true
+    "strictNullChecks": true,
+    "target": "ES2020"
   },
   "include": [
+    "./*.d.ts",
+    "./*.test-d.ts",
+    "/types/*.d.ts",
     "/types/*.test-d.ts",
-    "/types/*.d.ts"
+    "../test/*.test-d.ts"
   ]
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43121

increased by4.36%

Lines of code

345

increased by10.58%

Dependency changes

• Updated@fastify/under-pressure@^8.2.0