Shutdown Check

Search documentation

Find a page or section

Releases

shutdown-checkv1.0.1View as Markdown

Review what changed, check the installed version, and upgrade safely.

shutdown-check 1.0.1 is the current documented release. It adds CommonJS support and version flags to the first stable feature set released in 1.0.0.

No releases published yet.

This timeline is built from the GitHub releases of re-sohail/shutdown-check. It fills in on its own once the first one is published — see releases on GitHub.

Version 1.0.1

This maintenance release adds:

  • a CommonJS entry point;
  • matching TypeScript declarations for CommonJS;
  • shutdown-check --version;
  • the -v short flag;
  • package metadata and documentation improvements.

CommonJS projects can now use:

const { checkShutdown, defineConfig } = require("shutdown-check");

ESM usage remains unchanged:

import { checkShutdown, defineConfig } from "shutdown-check";

Version 1.0.0

The first stable release includes:

  • real process launch and cleanup;
  • readiness polling;
  • response-headers and probe start barriers;
  • 1 to 20 active workload requests;
  • SIGTERM delivery and optional repetition;
  • readiness withdrawal and new-request rejection checks;
  • response status and body verification;
  • process deadline and exit-code verification;
  • final port-closure verification;
  • stable diagnostic codes;
  • text, JSON, and JUnit output;
  • CLI and typed Node.js API.

Check the installed version

npx shutdown-check --version

Or inspect the local dependency:

npm list shutdown-check

Use the local project version in CI so the result matches development.

Upgrade

npm install -D shutdown-check@latest

After upgrading:

  1. Run shutdown-check --version.
  2. Run the existing shutdown test locally.
  3. Review the text timeline and exit code.
  4. Regenerate or inspect JUnit output if CI consumes it.
  5. Commit the lockfile change.

Version 1.0.1 does not require a config migration from 1.0.0.

Where does the changelog come from?

Release information is derived from the package's CHANGELOG.md and published version metadata. The documentation keeps the supported CLI, API, and config aligned with the installed package through build-time checks.