callcatcher
Version:
Your native NodeJS monitoring API
23 lines (22 loc) • 715 B
TypeScript
/// <reference types="node" />
import { Server } from 'http';
import { Report } from '../models/report';
/**
* After probing a server, the method send a report containing a Hit array
* The Report interface is the CallCatcher way of interfacing with
* the data. See The Report interface for more information.
* @example
* // express example
* // probe the server
* monitor.probe(server);
*
* // send the report on a custom route
* app.get('/stats', (req,res) => {
* res.status(210).json(monitor.report(server).getAllData())
* })
* @see probe
* @see Report
* @param {Server} server
* @return {Report}
*/
export declare function report(server: Server): Promise<Report>;