🚀 Graceful Server 🐢

Tiny (~5k), KISS, dependency-free Node.js library to make your Rest API graceful.

---

- Features
- Requirements
- Installation
- NPM
- PNPM
- YARN
- Endpoint
- /live
- /ready
- Example
- API Doc
- Integration with Docker
- Integration with Kubernetes
- Thanks
- Sponsors
- Donate

Features

✔ It's listening to system events to gracefully close your API on interruption.

✔ It facilitates the disconnect of data sources on shutdown.

✔ It facilitates the use of liveness and readiness.

✔ It manages the connections of your API.

✔ It avoids boilerplate codes.

✔ Kubernetes compliant.

✔ Dependency-free.

✔ KISS code base.

Requirements

✔ NodeJS >= 20.0

Installation

$3

``
npm install --save @gquittet/graceful-server
`

$3

`
pnpm add @gquittet/graceful-server
`

$3

`
yarn add @gquittet/graceful-server
`

Endpoint

Below, you can find the default endpoint, but you can set up or disable them. To do that, check out the Options part.

$3

The endpoint responds:

- 200 status code with the uptime of the server in second.

`json
{ "uptime": 42 }
`

Used to configure liveness probe.

$3

The endpoint responds:

- 200 status code if the server is ready.

`json
{ "status": "ready" }
`

- 503` status code with an empty response if the server is not ready (started, shutting down, etc.).

Example

See: EXAMPLE.md

API Doc

See: API.md

Integration with Docker

See: DOCKER.md

Integration with Kubernetes

See: KUBERNETES.md

Thanks

★ Terminus

★ Lightship

★ Stoppable

★ Bret Fisher for his great articles and videos

★ IBM documentation

★ Node HTTP documentation

★ Cloud Health

★ Cloud Health Connect

Sponsors

!JetBrains Logo

Donate


If you like my job, don't hesitate to contribute to this project! ❤️