Interface DarkSkyClient

Basic client definintion for interacting with the DarkSky API.

Hierarchy

DarkSkyClient

Index

Properties

Properties

forecast

forecast: <R>(request: ForecastRequest, params?: RequestParams) => Promise<R>

Make a Forecast request.

see: https://darksky.net/dev/docs#forecast-request
param: Forecast request data.
param: Optional query params to add to the request.
param: Optional config to change the way axios makes the request.

Type declaration

- <R>(request: ForecastRequest, params?: RequestParams): Promise<R>
- Type parameters
  - R: Forecast
  Parameters
  - request: ForecastRequest
  - Optional params: RequestParams
  Returns Promise<R>

timeMachine

timeMachine: <R>(request: TimeMachineRequest, params?: RequestParams) => Promise<R>

Make a TimeMachine request.

see: https://darksky.net/dev/docs#time-machine-request
param: TimeMachine request data.
param: Optional query params to add to the request.
param: Optional config to change the way axios makes the request.

Type declaration

- <R>(request: TimeMachineRequest, params?: RequestParams): Promise<R>
- Type parameters
  - R: Forecast
  Parameters
  - request: TimeMachineRequest
  - Optional params: RequestParams
  Returns Promise<R>

Generated using TypeDoc