@isaac-platform/isaac-integration-sdk/heartbeat.d.ts

A Typescript SDK for integrating with ISAAC

import { ISAACServer } from "./index";
import { EventEmitter } from "events";
export declare class Heartbeat extends EventEmitter {
    private isaacCore;
    private beating;
    private interval;
    /**
     * var status represents the connection to ISAAC
     * can be one of:
     * - uninitialized
     * - starting
     * - connected
     * - disconnected
     * - error
     */
    status: string;
    private intervalID?;
    /**
     * Creates ISAAC heartbeat handler.
     * @param isaacConn {ISAACServer} - uses ISAAC request definitions.
     */
    constructor(isaacConn: ISAACServer);
    /**
     * Starts heartbeat process and updates status.
     * @param interval {number} - (optional) override default 5000 ms interval
     */
    start(interval?: number): void;
    /**
     * Stops heartbeat process and updates status.
     */
    stop(): void;
    /**
     * Updates the connection status and emits on a change.
     * @param state {string} - New state to define and announce
     */
    updateStatus(state: string): void;
    /**
     * Makes async heartbeat PUT to ISAAC. Updates status to "connected" or "error" depending on acknowledgement from ISAAC.
     * TODO: Implement ISAAC message bus.
     */
    beat(): void;
}
//# sourceMappingURL=heartbeat.d.ts.map