Type Alias HeartbeatResponse

Heartbeat response payload.

type HeartbeatResponse = {
    errorCode: number;
    taggedFields: readonly TaggedField[];
    throttleTimeMs: number;
}

Properties

errorCode: number

Error code (0 = no error).

taggedFields: readonly TaggedField[]

Tagged fields (v4+).

throttleTimeMs: number

Time the request was throttled in milliseconds (v1+).