fruit-company/dist/lib/weather/models/weather-alert-collection.d.ts

Apple services library

import { ProductData } from "./base";
/**
 * A collecton of weather alerts.
 */
export interface WeatherAlertCollection extends ProductData {
    /** An array of weather alert summaries. */
    readonly alerts: WeatherAlertSummary[];
    /** A URL that provides more information about the alerts. */
    readonly detailsUrl?: string;
}
/**
 * Detailed information about the weather alert.
 */
export interface WeatherAlertSummary {
    /**
     * An official designation of the affected area.
     */
    readonly areaId?: string;
    /**
     * A human-readable name of the affected area.
     */
    readonly areaName?: string;
    /**
     * How likely the event is to occur.
     */
    readonly certainty: WeatherAlertCertainty;
    /**
     * The ISO code of the reporting country.
     */
    readonly countryCode: string;
    /**
     * A human-readable description of the event.
     */
    readonly description: string;
    /**
     * The URL to a page containing detailed information about the event.
     */
    readonly detailsUrl: string;
    /**
     * The time the event went into effect.
     */
    readonly effectiveTime: Date;
    /**
     * The time when the underlying weather event is projected to end.
     */
    readonly eventEndTime?: Date;
    /**
     * The time when the underlying weather event is projected to start.
     */
    readonly eventOnsetTime?: Date;
    /**
     * The time when the event expires.
     */
    readonly expireTime: Date;
    /**
     * A unique identifier of the event.
     */
    readonly id: Date;
    /**
     * The time that event was issued by the reporting agency.
     */
    readonly issuedTime: Date;
    /**
     * An array of recommended actions from the reporting agency.
     */
    readonly responses: WeatherAlertResponseType[];
    /**
     * The level of danger to life and property.
     */
    readonly severity: WeatherAlertSeverity;
    /**
     * The name of the reporting agency.
     */
    readonly source: string;
    /**
     * An indication of urgency of action from the reporting agency.
     */
    readonly urgency?: WeatherAlertUrgency;
}
/**
 * How likely the event is to occur.
 */
export type WeatherAlertCertainty = "observed" | "likely" | "possible" | "unlikely" | "unknown";
/**
 * An indication of urgency of action from the reporting agency.
 */
export type WeatherAlertUrgency = "immediate" | "expected" | "future" | "past" | "unknown";
/**
 * The level of danger to life and property.
 */
export type WeatherAlertSeverity = "extreme" | "severe" | "moderate" | "minor" | "unknown";
/**
 * The recommended action from a reporting agency.
 */
export type WeatherAlertResponseType = "shelter" | "evacuate" | "prepare" | "execute" | "avoid" | "monitor" | "assess" | "allClear" | "none";