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.

Table of contents ​

Constructors ​

• constructor

Methods ​

• build
• free
• logLevel
• network
• seedNodes

Constructors ​

constructor ​

• 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:963

Methods ​

build ​

▸ build(): PlainClientConfiguration

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

Returns ​

PlainClientConfiguration

Defined in ​

web.d.ts:991

free ​

▸ free(): void

Returns ​

void

Defined in ​

web.d.ts:957

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 ​

Returns ​

void

Defined in ​

web.d.ts:986

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 ​

Returns ​

void

Defined in ​

web.d.ts:971

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 ​

Returns ​

void

Defined in ​

web.d.ts:978