# Class: IgniteClientConfiguration

## IgniteClientConfiguration(…endpoints)

Class representing Ignite client configuration.

The configuration includes:

- (mandatory) Ignite node endpoint(s)
- (optional) user credentials for authentication
- (optional) TLS enabling
- (optional) connection options

## Constructor

#### new IgniteClientConfiguration(…endpoints)

Creates an instance of Ignite client configuration with the provided mandatory settings and default optional settings.

By default, the client does not use authentication and secure connection.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`endpoints` | string | <repeatable> | Ignite node endpoint(s). The client randomly connects/reconnects to one of the specified node.

Source:
  - IgniteClientConfiguration.js, line 34

### Methods

#### setConnectionOptions(useTLS, connectionOptionsopt) → {IgniteClientConfiguration}

Sets connection options.

By default the client establishes a non-secure connection with default connection options defined by nodejs.

##### Parameters:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`useTLS` | boolean |  |  | if true, secure connection will be established; if false, non-secure connection will be established.
`connectionOptions` | object | <optional> | null | connection options. For non-secure connection options defined here https://nodejs.org/api/net.html#net_net_createconnection_options_connectlistener For secure connection options defined here https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Source:
  - IgniteClientConfiguration.js, line 105

##### Returns:

- the same instance of the IgniteClientConfiguration.

Type
  IgniteClientConfiguration

#### setPassword(password) → {IgniteClientConfiguration}

Sets password which will be used for authentication during the client's connection.

Password is ignored, if username is not set. If password is not set, it is considered empty.

##### Parameters:

Name | Type | Description
--- | --- | ---
`password` | string | password. If null, password is empty.

Source:
  - IgniteClientConfiguration.js, line 87

##### Throws:

if error.

Type
  IgniteClientError

##### Returns:

- the same instance of the IgniteClientConfiguration.

Type
  IgniteClientConfiguration

#### setUserName(userName) → {IgniteClientConfiguration}

Sets username which will be used for authentication during the client's connection.

If username is not set, the client does not use authentication during connection.

##### Parameters:

Name | Type | Description
--- | --- | ---
`userName` | string | username. If null, authentication is disabled.

Source:
  - IgniteClientConfiguration.js, line 70

##### Throws:

if error.

Type
  IgniteClientError

##### Returns:

- the same instance of the IgniteClientConfiguration.

Type
  IgniteClientConfiguration