Class APICallResponseData

Structured log data for an API response.

Hierarchy (View Summary)

APICallLogData
- APICallResponseData

Index

Constructors

Properties

dataType headers method? params requestData responseData status? url?

Methods

Constructors

constructor

new APICallResponseData(
    response?: HttpResponse<unknown>,
    requestConfig?: LoggableRequestConfig,
    redaction?: Redaction,
): APICallResponseData
Captures a response (and the request that produced it) into a loggable snapshot.
Parameters
- Optionalresponse: HttpResponse<unknown>
  Normalized response to snapshot.
- OptionalrequestConfig: LoggableRequestConfig
  Request configuration the response answered.
- Optionalredaction: Redaction
  Redaction engine carrying the consumer's sensitive-key vocabulary; defaults to the base one.
Returns APICallResponseData
Overrides APICallLogData.constructor
- Defined in src/observability/response.ts:26

Properties

`Readonly`dataType

dataType: "API response" = 'API response'

`Readonly`headers

headers: unknown

`Optional` `Readonly`method

method?: string

`Readonly`params

params: unknown

`Readonly`requestData

requestData: unknown

`Readonly`responseData

responseData: unknown

`Optional` `Readonly`status

status?: number

`Optional` `Readonly`url

url?: string

Methods

toString

toString(): string
Serializes the log data to JSON in the fixed key order, redacting every value through the injected vocabulary. ONE record is ONE line: the host that reads these lines back (a Homey diagnostic report) keeps about the last hundred lines of an app's stdout, and an indented Classic /User/ListDevices body alone ran past that window, so a report carried the tail of one dump and no other line at all. A body above MAX_LOGGED_BODY_BYTES is omitted whole and counted, so a hundred records also fit the report's upload.

Returns string
The redacted, single-line JSON record.
Inherited from APICallLogData.toString
- Defined in src/observability/context.ts:107