---
url: /docs/api/garmin-connect/functions/createGarminConnectClient.md
---
[**@kaiord/garmin-connect**](../README.md)

***

[@kaiord/garmin-connect](../README.md) / createGarminConnectClient

# Function: createGarminConnectClient()

> **createGarminConnectClient**(`options?`): [`GarminConnectClient`](../type-aliases/GarminConnectClient.md)

Defined in: [garmin-connect/src/adapters/client/garmin-connect-client.ts:28](https://github.com/pablo-albaladejo/kaiord/blob/3eacbe62ef72342d970523967cc5155b5935bb85/packages/garmin-connect/src/adapters/client/garmin-connect-client.ts#L28)

Create a Garmin Connect client with auth, workout service, and optional token auto-restore.

## Parameters

### options?

[`GarminConnectClientOptions`](../type-aliases/GarminConnectClientOptions.md)

## Returns

[`GarminConnectClient`](../type-aliases/GarminConnectClient.md)

## Example

```ts
const client = createGarminConnectClient({
  tokenStore: createFileTokenStore(),
  retry: { maxRetries: 3 },
});
const { restored } = await client.init();
if (!restored) await client.auth.login(email, password);
```