---
title: "Class: ClientConfiguration"
canonical_url: "https://nimiq.dev/web-client/reference/classes/clientconfiguration"
---
# Class: ClientConfiguration

[@nimiq/core](../globals) / ClientConfiguration

Defined in: @nimiq/core/types/wasm/web.d.ts:1051

Use this to provide initialization-time configuration to the Client.
This is a simplified version of the configuration that is used for regular nodes,
since not all configuration knobs are available when running inside a browser.

## Constructors

### Constructor

> **new ClientConfiguration**(): `ClientConfiguration`

Defined in: @nimiq/core/types/wasm/web.d.ts:1087

Creates a default client configuration that can be used to change the client's configuration.

Use its `instantiateClient()` method to launch the client and connect to the network.

#### Returns

`ClientConfiguration`

## Methods

### [dispose]()

> **[dispose]**(): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1053

#### Returns

`void`

---

### build()

> **build**(): [`PlainClientConfiguration`](../interfaces/PlainClientConfiguration)

Defined in: @nimiq/core/types/wasm/web.d.ts:1057

Returns a plain configuration object to be passed to `Client.create`.

#### Returns

[`PlainClientConfiguration`](../interfaces/PlainClientConfiguration)

---

### desiredPeerCount()

> **desiredPeerCount**(`desired_peer_count`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1062

Sets the desired number of peers the client should try to connect to.
Default is `12`.

#### Parameters

##### desired_peer_count

`number`

#### Returns

`void`

---

### free()

> **free**(): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1052

#### Returns

`void`

---

### logLevel()

> **logLevel**(`log_level`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1069

Sets the log level that is used when logging to the console.

Possible values are `'trace' | 'debug' | 'info' | 'warn' | 'error'`.
Default is `'info'`.

#### Parameters

##### log_level

`string`

#### Returns

`void`

---

### network()

> **network**(`network`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1076

Sets the network ID the client should use. Input is case-insensitive.

Possible values are `'MainAlbatross' | 'TestAlbatross' | 'DevAlbatross'`.
Default is `'MainAlbatross'`.

#### Parameters

##### network

`string`

#### Returns

`void`

---

### networkBufferSize()

> **networkBufferSize**(`network_buffer_size`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1081

Sets the maximum network buffer size, which should be greater than 0
Default is `1024`.

#### Parameters

##### network_buffer_size

`number`

#### Returns

`void`

---

### onlySecureWsConnections()

> **onlySecureWsConnections**(`only_secure_ws_connections`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1092

Sets whether the client should only connect to secure WebSocket connections.
Default is `true`.

#### Parameters

##### only_secure_ws_connections

`boolean`

#### Returns

`void`

---

### peerCountMax()

> **peerCountMax**(`peer_count_max`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1097

Sets the maximum number of peers the client should connect to.
Default is `50`.

#### Parameters

##### peer_count_max

`number`

#### Returns

`void`

---

### peerCountPerIpMax()

> **peerCountPerIpMax**(`peer_count_per_ip_max`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1102

Sets the maximum number of peers the client should connect to per IP address.
Default is `10`.

#### Parameters

##### peer_count_per_ip_max

`number`

#### Returns

`void`

---

### peerCountPerSubnetMax()

> **peerCountPerSubnetMax**(`peer_count_per_subnet_max`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1107

Sets the maximum number of peers the client should connect to per subnet.
Default is `10`.

#### Parameters

##### peer_count_per_subnet_max

`number`

#### Returns

`void`

---

### seedNodes()

> **seedNodes**(`seeds`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1115

Sets the list of seed nodes that are used to connect to the Nimiq Albatross network.

Each array entry must be a proper Multiaddr format string.

Throws when an entry cannot be deserialized as a string.

#### Parameters

##### seeds

`any`<span>



</span>



#### Returns

`void`

---

### syncMode()

> **syncMode**(`sync_mode`): `void`

Defined in: @nimiq/core/types/wasm/web.d.ts:1121

Sets the sync mode that should be used.
Only "light" and "pico" are supported for web clients
Default is "pico"

#### Parameters

##### sync_mode

`string`

#### Returns

`void`


## Sitemap

See the full [sitemap](https://nimiq.dev/sitemap.md) for all pages.