Skip to content

Class: ClientConfiguration

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

new ClientConfiguration()

new ClientConfiguration(): ClientConfiguration

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

Defined in

web.d.ts:994

Methods

build()

build(): PlainClientConfiguration

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

Returns

PlainClientConfiguration

Defined in

web.d.ts:1022


free()

free(): void

Returns

void

Defined in

web.d.ts:988


logLevel()

logLevel(log_level): void

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

Defined in

web.d.ts:1017


network()

network(network): void

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

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

Parameters

network: string

Returns

void

Defined in

web.d.ts:1002


seedNodes()

seedNodes(seeds): void

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.

Parameters

seeds: any[]

Returns

void

Defined in

web.d.ts:1009