owm-onecall-api
Version:
A wrapper for OpenWeatherMap's 'onecall' API.
97 lines (96 loc) • 2.58 kB
TypeScript
import { DarkSkyDataPoint, DarkSkyDataBlock } from "./darksky-datablock";
import { DailyDataBlock } from "../types";
/**
* A DarkSky equivelent Daily DataBlock.
*
* See {@link DarkSkyDataBlock}
*/
export interface DarkSkyDailyDataBlock extends DarkSkyDataBlock {
data: DarkSkyDailyDataPoint[];
}
/**
* A DarkSky equivelent of a Daily OpenWeatherMap DataBlock.
*
* See {@link DailyDataBlock} for more.
*/
export interface DarkSkyDailyDataPoint extends DarkSkyDataPoint {
/**
* Sunrise time as a UTC Unix timestamp.
*
* Mapped from DailyDataBlock.sunrise
*/
sunriseTime: number;
/**
* Sunrise time as a UTC Unix timestamp.
*
* Mapped from DailyDataBlock.sunrise
*/
sunsetTime: number;
/**
* The daytime high temperature.
*
* Mapped from DailyDataBlock.temp.day
*/
temperatureHigh: number;
/**
* The overnight low temperature.
*
* Mapped from DailyDataBlock.temp.night
*/
temperatureLow: number;
/**
* The daytime high apparent temperature.
*
* Mapped from DailyDataBlock.feels_like.day
*/
apparentTemperatureHigh: number;
/**
* The overnight low apparent temperature.
*
* Mapped from DailyDataBlock.feels_like.night
*/
apparentTemperatureLow: number;
/**
* The maximum temperature during a given date.
*
* Mapped from DailyDataBlock.temp.max
*/
temperatureMax: number;
/**
* The minimum temperature during a given date.
*
* Mapped from DailyDataBlock.temp.min
*/
temperatureMin: number;
/**
* The apparent maximum temperature during a given date.
*
* Mapped from DailyDataBlock.feels_like.max
*/
apparentTemperatureMax: number;
/**
* The apparent minimum temperature during a given date.
*
* Mapped from DailyDataBlock.feels_like.min
*/
apparentTemperatureMin: number;
/**
* Midday UV index
*
* Mapped from DailyDataBlock.uvi
*/
uvIndex: number;
/**
* Probability of precipitation.
*
* Mapped from DataBlock.pop
*/
precipProbability: number;
}
/**
* Map a given OpenWeatherMap object to the Dark Sky equivelent.
*
* @param dataBlock OpenWeatherMap Daily data block.
* @returns DarkSky equivelent Daily data block object.
*/
export declare function mapDailyToDarkSky(blocks?: DailyDataBlock[]): DarkSkyDailyDataBlock | undefined;