Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kody/environment

src/index.ts

39 lines · 1.5 KB · TypeScript
export {
	getAirQuality,
	summarizeAirQuality,
	type AirQualityLookupParams,
	type AirQualitySummary,
} from './aqi.ts'

/** Package overview and named air-quality helpers re-exported from the root entry. */
export default async function describeEnvironmentPackage() {
	return {
		package: '@kody/environment',
		intent:
			'Reusable environment helpers for weather, geocoding, sun times, moon phase, air quality, elevation, forecast history, combined outdoor snapshots, and location resolution.',
		exports: [
			'weather',
			'weather-geocode',
			'sun',
			'moon',
			'air-quality',
			'elevation',
			'forecast-history',
			'snapshot',
		],
		namedExports: [
			'getAirQuality({ location } | { latitude, longitude })',
			'summarizeAirQuality({ location } | { latitude, longitude })',
		],
		notes: [
			'Pass a city/place string as `location`, or `latitude` + `longitude` (optional `label`). There is no default home location.',
			'Use weather-geocode to resolve a free-form place name into reusable coordinates.',
			'Use weather for daily or hourly weather lookups with either location text or direct coordinates.',
			'Use sun for sunrise, sunset, twilight, and day-length lookups.',
			'Use moon for locally computed moon phase, illumination, and next full/new moon dates.',
			'Use elevation for ground elevation in meters and feet.',
			'Use air-quality subpath for the full lookup payload with hourly series.',
			'Use snapshot for a one-call combined weather + air quality + sun + moon report.',
		],
	}
}