Interface AlertsParams

Parameters for client.alerts().

interface AlertsParams {
    cap?: boolean;
    lang?: "de" | "en";
    states?: readonly string[];
}

Index

Properties

cap? lang? states?

Properties

`Optional`cap

cap?: boolean

Include the CAP (Common Alerting Protocol) detail block per alert.

`Optional`lang

lang?: "de" | "en"

Response language (Accept-Language). Default: de.

`Optional`states

states?: readonly string[]

Subset of state codes; case-insensitive input is normalised to upper.