Class OpenWeatherMapRecipe

Recipe providing configuration and query mapping for the OpenWeatherMap REST API.

Implements

RestApiRecipe

Index

Constructors

Properties

defaultBaseUrl name querySerializer

Methods

Constructors

constructor

new OpenWeatherMapRecipe(apiKey: string): OpenWeatherMapRecipe
Parameters
- apiKey: string
Returns OpenWeatherMapRecipe
- Defined in OpenWeatherMapRecipe.ts:16

Properties

defaultBaseUrl

defaultBaseUrl: string = 'https://api.openweathermap.org/data/2.5'

The default endpoint URL.

name

name: string = 'OpenWeatherMap'

The human-readable name of the recipe.

querySerializer

querySerializer: QuerySerializer = ...

Custom query serializer transforming Quatrain filters into OpenWeatherMap parameters.

Param: filters

Active filters.

Param: pagination

Pagination details.

Returns

The parameter record.

Methods

getOptions

getOptions(
apiKey?: string,
overrides?: Partial<RestAdapterOptions>,
): RestAdapterOptions
Returns the composed REST adapter options.
Parameters
- OptionalapiKey: string
  Optional API key (overrides constructor value).
- Optionaloverrides: Partial<RestAdapterOptions>
  Additional adapter options.
Returns RestAdapterOptions
The generated adapter options.
Implementation of RestApiRecipe.getOptions
- Defined in OpenWeatherMapRecipe.ts:55