Module "client"

Index

Interfaces

DarkSkyClient

Functions

Functions

createAPIUrl

createAPIUrl(token: string, __namedParameters: { latitude: NumberString; longitude: NumberString; rest: rest }): string

- Defined in src/client.ts:96
Create the URL for the request which includes the api token, and location.

Parameters
- token: string
  
  Developer API token.
- __namedParameters: { latitude: NumberString; longitude: NumberString; rest: rest }
  - latitude: NumberString
  - longitude: NumberString
  - rest: rest
Returns string

URL string for making the request.

createClient

createClient(apiToken: string, requestConfig?: AxiosRequestConfig): DarkSkyClient

- Defined in src/client.ts:52
Default implementation of ClientFactory for making authorized requests to the DarkSky API.

Note: Get your token from https://darksky.net/dev/account.

Parameters
- apiToken: string
  
  Developer API token.
- Default value requestConfig: AxiosRequestConfig = {}
  
  Optional config to change the way axios makes the request.
Returns DarkSkyClient

Client for interacting with the API.

createQueryParams

createQueryParams(obj: RequestParams): string

- Defined in src/client.ts:117
Takes a params object and converts it to an HTTP query parameters string.
```
const params: RequestParams = { exclude: ['hourly', 'daily'], lang: 'en' }
const query: string = createQueryParams(params)
// query = '?exclude=hourly,daily&lang=en'
```
Parameters
- obj: RequestParams
  
  Params object to convert into Query parameters.
Returns string

A query parameter string.

doRequest

doRequest<R>(apiToken: string, request: ForecastRequest, params: RequestParams, requestConfig: AxiosRequestConfig): Promise<R>

- Defined in src/client.ts:74
Make the API request, and add the response headers to the result.

Type parameters
- R: Forecast
  
  Type of response that extends Forecast.
Parameters
- apiToken: string
  
  Developer API token.
- request: ForecastRequest
  
  Forecast request data.
- params: RequestParams
  
  Optional query params to add to the request.
- requestConfig: AxiosRequestConfig
  
  Optional config to change the way axios makes the request.
Returns Promise<R>

Forecast response with the HTTP headers.

Generated using TypeDoc