import { TimeSpan } from '@elaraai/core/east';
import { Cache } from '@elaraai/core/datasource';
import { ELARASchema } from '@elaraai/core/schema';
/**
 * The environment variables to define an {@link MyobPluginDefinition}.
 *
 * @category DataSource
 */
export declare type WeatherEnv = {
    WEATHER_NAME?: string;
    WEATHER_GEOHASH?: string;
    WEATHER_STATE?: string;
};
/**
 * A {@link WeatherPluginDefinition} to configure the {@link WeatherPlugin}.
 *
 * @category DataSource
 */
export declare type WeatherPluginDefinition = {
    /** the configuration of the DataSource {@link Poll} */
    poll?: TimeSpan;
    /**  the configuration of the {@link Cache} for the DataSource. */
    cache?: Cache;
    /** the environment variables to apply to the {@link WeatherPluginDefinition} */
    env?: WeatherEnv;
};
/**
 * Create a streaming {@link DataSourceDefinition} combining BOM historic and forecast weather for a specific location with supporting diagnostic pages: {@link https://apidoc.kounta.com/}.
 *
 * @param definition: the desired {@link MyobPluginDefinition}.
 * @return a {@link ELARASchema} containing a {@link MyobPluginDefinition} contents
 *
 * @category DataSource
 * @remarks Use of this plugin requires manually defining the following `Environment` values with respect to each other:
 *   - WEATHER_NAME: the name of a station as found in ftp://ftp.bom.gov.au/anon/gen/clim_data/IDCKWCDEA0/tables/stations_db.txt
 *   - WEATHER_GEOHASH, WEATHER_STATE: the geohash and state of the station, as by searching by postcode https://api.weather.bom.gov.au/v1/locations?search=3130
 *
 * @example
 * ```typescript
 *   // After setting environment values as:
 *   // export WEATHER_GEOHASH=r3gx2sp
 *   // export WEATHER_NAME='sydney_(observatory_hill)'
 *   // export WEATHER_STATE='nsw'
 *   // Create a `WeatherPlugin` for Sydney city:
 *   const weather = WeatherPlugin({
 *       poll: TimeSpan(1)
 *   })
 * ```
 */
export declare function WeatherPlugin(args?: WeatherPluginDefinition): ELARASchema;
//# sourceMappingURL=weather.d.ts.map