owm-onecall-api
Version:
A wrapper for OpenWeatherMap's 'onecall' API.
55 lines (54 loc) • 1.66 kB
TypeScript
import { DarkSkyDataPoint, DarkSkyDataBlock } from "./darksky-datablock";
import { HourlyDataBlock } from "../types";
/**
* A DarkSky equivelent DataBlock.
*
* See {@link DarkSkyDataBlock}
*/
export interface DarkSkyHourlyDataBlock extends DarkSkyDataBlock {
data: DarkSkyHourlyDataPoint[];
}
/**
* A DarkSky equivelent of a Hourly OpenWeatherMap DataBlock.
*
* See {@link HourlyDataBlock} for more.
*/
export interface DarkSkyHourlyDataPoint extends DarkSkyDataPoint {
/**
* Forecasted temperature.
*
* Depending on the [[Units]] selected this value will change.
*
* Units – default: kelvin, metric: Celsius, imperial: Fahrenheit.
*
* Mapped from DarkSkyDataPoint.temp
*/
temperature: number;
/**
* Temperature that accounts for the human perception of weather.
*
* Depending on the [[Units]] selected this value will change.
*
* [[Units]] – default: kelvin, metric: Celsius, imperial: Fahrenheit.
*
* Mapped from HourlyDataBlock.feels_like
*/
apparentTemperature: number;
/**
* Probability of precipitation.
*
* Mapped from DataBlock.pop
*/
precipProbability: number;
/**
* Average visibility measured in metres (m).
*/
visibility: number;
}
/**
* Map the OpenWeatherMap HourlyDataBlock to a DarkSky equivelent object.
*
* @param blocks List of OpenWeatherMap hourly data blocks.
* @returns `undefined` if [[blocks]] is empty.
*/
export declare function mapHourlyToDarkSky(blocks?: HourlyDataBlock[]): DarkSkyHourlyDataBlock | undefined;