> ## Documentation Index
> Fetch the complete documentation index at: https://stars-components.js.org/llms.txt
> Use this file to discover all available pages before exploring further.

# @wolfstar/weather-helpers

> Fetch weather data and convert common units.

<CodeGroup>
  ```bash npm theme={"system"}
  npm install @wolfstar/weather-helpers
  ```

  ```bash pnpm theme={"system"}
  pnpm add @wolfstar/weather-helpers
  ```

  ```bash yarn theme={"system"}
  yarn add @wolfstar/weather-helpers
  ```

  ```bash bun theme={"system"}
  bun add @wolfstar/weather-helpers
  ```
</CodeGroup>

<CardGroup cols={2}>
  <Card title="npm" icon="npm" horizontal href="https://npmx.dev/package/@wolfstar/weather-helpers" />

  <Card title="Source" icon="github" horizontal href="https://github.com/wolfstar-project/stars-components/tree/main/packages/weather-helpers" />
</CardGroup>

## Description

Very basic weather helper functions for several Star bots to ensure we do not duplicate code.

## Features

* Powered by the `@wolfstar/safe-fetch` package

## Usage

You can use the functions exported from this package to interact with the [Weather API](https://wttr.in).

```typescript theme={"system"}
import { getWeatherData } from '@wolfstar/weather-helpers';

const result = await getWeatherData('Amsterdam', 'en-us');
console.log(result);
```

<details>
  <summary>Here is an example request</summary>

  ```json theme={"system"}
  {
  	"current_condition": [
  		{
  			"FeelsLikeC": "-2",
  			"FeelsLikeF": "28",
  			"cloudcover": "75",
  			"humidity": "80",
  			"localObsDateTime": "2024-01-06 11:21 PM",
  			"observation_time": "10:21 PM",
  			"precipInches": "0.0",
  			"precipMM": "0.0",
  			"pressure": "1017",
  			"pressureInches": "30",
  			"temp_C": "2",
  			"temp_F": "36",
  			"uvIndex": "1",
  			"visibility": "10",
  			"visibilityMiles": "6",
  			"weatherCode": "116",
  			"weatherDesc": [
  				{
  					"value": "Partly cloudy"
  				}
  			],
  			"weatherIconUrl": [
  				{
  					"value": ""
  				}
  			],
  			"winddir16Point": "NNE",
  			"winddirDegree": "30",
  			"windspeedKmph": "22",
  			"windspeedMiles": "14"
  		}
  	],
  	"nearest_area": [
  		{
  			"areaName": [
  				{
  					"value": "Amsterdam"
  				}
  			],
  			"country": [
  				{
  					"value": "Netherlands"
  				}
  			],
  			"latitude": "52.374",
  			"longitude": "4.890",
  			"population": "741636",
  			"region": [
  				{
  					"value": "North Holland"
  				}
  			],
  			"weatherUrl": [
  				{
  					"value": ""
  				}
  			]
  		}
  	],
  	"request": [
  		{
  			"query": "Lat 52.37 and Lon 4.90",
  			"type": "LatLon"
  		}
  	],
  	"weather": []
  }
  ```
</details>