From af62dd2b9aca48afbf28f937d3102a9fcd18cd6d Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 8 Oct 2019 15:34:06 -0600 Subject: [PATCH] added types for express-status-monitor (#38977) --- .../express-status-monitor-tests.ts | 43 ++++++++++++++++++ types/express-status-monitor/index.d.ts | 45 +++++++++++++++++++ types/express-status-monitor/tsconfig.json | 23 ++++++++++ types/express-status-monitor/tslint.json | 1 + 4 files changed, 112 insertions(+) create mode 100644 types/express-status-monitor/express-status-monitor-tests.ts create mode 100644 types/express-status-monitor/index.d.ts create mode 100644 types/express-status-monitor/tsconfig.json create mode 100644 types/express-status-monitor/tslint.json diff --git a/types/express-status-monitor/express-status-monitor-tests.ts b/types/express-status-monitor/express-status-monitor-tests.ts new file mode 100644 index 0000000000..f2231c13a8 --- /dev/null +++ b/types/express-status-monitor/express-status-monitor-tests.ts @@ -0,0 +1,43 @@ +import express = require('express'); +import expressStatusMonitor = require('express-status-monitor'); +import socketIO = require('socket.io'); + +const app = express(); +app.use(expressStatusMonitor()); +app.use( + expressStatusMonitor({ + title: 'Type Test', + theme: 'default.css', + path: '/status', + socketPath: '/socket.io', + websocket: null, + chartVisibility: { + cpu: true, + mem: false, + load: true, + }, + ignoreStartsWith: '/admin', + healthChecks: [], + }), +); +app.use( + expressStatusMonitor({ + spans: [{ interval: 10000, retention: 60 * 1000 }], + healthChecks: [ + { + protocol: 'http', + host: 'localhost', + path: '/healthcheck', + port: '4000', + }, + ], + }), +); + +const io = socketIO.listen(80); + +app.use( + expressStatusMonitor({ + websocket: io, + }), +); diff --git a/types/express-status-monitor/index.d.ts b/types/express-status-monitor/index.d.ts new file mode 100644 index 0000000000..2d1bd96025 --- /dev/null +++ b/types/express-status-monitor/index.d.ts @@ -0,0 +1,45 @@ +// Type definitions for express-status-monitor 1.2 +// Project: https://github.com/RafalWilinski/express-status-monitor#readme +// Definitions by: Alex Anderson +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +/// + +import express = require('express'); + +declare namespace e { + interface ExpressStatusMonitorConfig { + title?: string; + theme?: string; + path?: string; + socketPath?: string; + websocket?: SocketIO.Server | null; // References a socket.io instance + spans?: RetentionSpan[]; + chartVisibility?: { + cpu?: boolean; + mem?: boolean; + load?: boolean; + responseTime?: boolean; + rps?: boolean; + statusCodes?: boolean; + }; + healthChecks?: HealthCheck[]; + ignoreStartsWith?: string; + } + + 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; diff --git a/types/express-status-monitor/tsconfig.json b/types/express-status-monitor/tsconfig.json new file mode 100644 index 0000000000..70373e33a8 --- /dev/null +++ b/types/express-status-monitor/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "express-status-monitor-tests.ts" + ] +} diff --git a/types/express-status-monitor/tslint.json b/types/express-status-monitor/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/express-status-monitor/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }