System - Chromiumly

All methods are static. They call the configured Gotenberg endpoint from Chromiumly.configure(). Every method accepts an optional trace argument (custom request id, mapped to the Gotenberg-Trace header — see Request tracing).

getHealth(trace?)

Get the JSON health report from GET /health.

System.getHealth(trace?: string): Promise<Buffer>

headHealth(trace?)

Run a lightweight health check with HEAD /health. Returns an empty buffer on success.

System.headHealth(trace?: string): Promise<Buffer>

getVersion(trace?)

Get the Gotenberg version from GET /version.

System.getVersion(trace?: string): Promise<Buffer>

getDebug(trace?)

Get debug data from GET /debug.

System.getDebug(trace?: string): Promise<Buffer>

This endpoint is available only when Gotenberg enables debug data.

getPrometheusMetrics(trace?)

Get Prometheus metrics from GET /prometheus/metrics.

System.getPrometheusMetrics(trace?: string): Promise<Buffer>

​getHealth(trace?)

​headHealth(trace?)

​getVersion(trace?)

​getDebug(trace?)

​getPrometheusMetrics(trace?)

getHealth(trace?)

headHealth(trace?)

getVersion(trace?)

getDebug(trace?)

getPrometheusMetrics(trace?)