callcatcher
Version:
Your native NodeJS monitoring API
32 lines (31 loc) • 877 B
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.probe = void 0;
var probe_1 = require("../models/probe");
/**
* @callback onHitCallback
* @param {(Error | null)} error
* @param {Hit[]} documents
* @return {void}
*/
/**
* Probing a server makes the library intercept all of the
* incoming requests and locally stores them so they can be
* used during future processes, like reporting.
* @example
* // express example
* // create a server
* const server = app.listen(8080, () => {
* console.log("Listening on port 8080")
* });
*
* // probe the server
* monitor.probe(server);
* @param {Server} server
* @param {onHitCallback} onHitCallback
* @return {Probe}
*/
function probe(server, onHitCallback) {
return new probe_1.Probe(server, onHitCallback);
}
exports.probe = probe;