@types/express-status-monitor
Version:
TypeScript definitions for express-status-monitor
60 lines (50 loc) • 2.09 kB
Markdown
# Installation
> `npm install --save @types/express-status-monitor`
# Summary
This package contains type definitions for express-status-monitor (https://github.com/RafalWilinski/express-status-monitor#readme).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-status-monitor.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/express-status-monitor/index.d.ts)
````ts
import express = require("express");
import SocketIO = require("socket.io");
declare namespace e {
interface ExpressStatusMonitorConfig {
title?: string | undefined;
theme?: string | undefined;
path?: string | undefined;
socketPath?: string | undefined;
websocket?: SocketIO.Server | null | undefined; // References a socket.io instance
spans?: RetentionSpan[] | undefined;
chartVisibility?: {
cpu?: boolean | undefined;
mem?: boolean | undefined;
load?: boolean | undefined;
/** @default true */
heap?: boolean | undefined;
responseTime?: boolean | undefined;
rps?: boolean | undefined;
statusCodes?: boolean | undefined;
} | undefined;
healthChecks?: HealthCheck[] | undefined;
ignoreStartsWith?: string | undefined;
}
interface RetentionSpan {
interval: number;
retention: number;
}
interface HealthCheck {
protocol: string;
host: string;
path: string;
port: string | number;
}
}
declare function e(config?: e.ExpressStatusMonitorConfig): express.RequestHandler;
export = e;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 03:09:37 GMT
* Dependencies: [@types/express](https://npmjs.com/package/@types/express), [@types/socket.io](https://npmjs.com/package/@types/socket.io)
# Credits
These definitions were written by [Alex Anderson](https://github.com/alexanderson1993), and [Prashant Sharma](https://github.com/tecxar-prashant).