owm-onecall-api
Version:
A wrapper for OpenWeatherMap's 'onecall' API.
17 lines (16 loc) • 977 B
TypeScript
import { AxiosRequestConfig } from "axios";
import { RequestParams, ForecastRequest, TimeMachineRequest } from "../types";
import { DarkSkyForecastRequest, DarkSkyTimeMachineRequest } from "./darksky-request";
/**
* Create a DarkSky compatible [[OpenWeatherMapClient]].
*
* Note: Get your token from {@link https://openweathermap.org/full-price#current OpenWeatherMap}.
*
* @param apiToken Developer API token.
* @param requestConfig Optional config to change the way axios makes the request.
* @returns Client for interacting with the API.
*/
export declare function darkSkyCompatClient(apiToken: string, requestConfig?: AxiosRequestConfig): {
forecast: (request: ForecastRequest | DarkSkyForecastRequest, params?: RequestParams) => Promise<import("./darksky-forecast").DarkSkyForecast>;
timeMachine: (request: TimeMachineRequest | DarkSkyTimeMachineRequest, params?: RequestParams) => Promise<import("./darksky-forecast").DarkSkyForecast>;
};