@reactivemarkets/switchboard-sdk/lib/domain/iHeartbeatBuilder.d.ts

SDK for the Reactive Markets Switchboard

import { IMetric } from "../iMetric";
import { IMessageBuilder } from "./iMessageBuilder";
export interface IHeartbeatBuilder extends IMessageBuilder {
    /**
     * Required when the heartbeat is the result of a Test Request.
     * @param requestId The request id.
     */
    requestId(requestId?: string | Uint8Array | null): IHeartbeatBuilder;
    /**
     * Optional array of metrics for monitoring purposes.
     * @param metrics The metics array.
     */
    metrics(metrics: IMetric[]): IHeartbeatBuilder;
}