# @skbkontur/cluster-config-client

> Клиент к сервису конфигурации кластера контура

Latest version **0.0.5** (published 2018-03-14) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @skbkontur/cluster-config-client
pnpm add @skbkontur/cluster-config-client
yarn add @skbkontur/cluster-config-client
bun add @skbkontur/cluster-config-client
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2018-03-14 |
| First published | 2017-10-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ssamooilov_skbkontur, t1mmaas, tihonove, ubitso4, wkich |

## Links

- npm: https://www.npmjs.com/package/@skbkontur/cluster-config-client
- Repository: https://git.skbkontur.ru/portal/Node.ClusterConfigClient
- npm.io page: https://npm.io/package/@skbkontur/cluster-config-client

## Recent versions

- 0.0.5 (latest) — 2018-03-14
- 0.1.0-rc.1 (next) — 2018-10-10
- 0.0.4 — 2018-03-13
- 0.0.3 — 2017-12-25
- 0.0.2 — 2017-10-27
- 0.0.1 — 2017-10-27

## README

# Клиент для получения настроек из ClusterConfig

## Пример создания инстанса кластер конфига
```javascript
const ClusterConfigClient = require('cluster-config-client')

const clusterConfig = new ClusterConfigClient({
  zone: 'default',
  host: 'clusterconfig',
  port: 9000,
  updateInterval: 60000
})
```

## Доступные методы

### `constructor(settings, localConfig)`

###### settings {Object|required}
Настройки клиента кластер конфига. Значение по умолчанию:
```javascript
{
  zone: 'default',
  host: 'clusterconfig',
  port: 9000,
  updateInterval: 90000
}
```

###### localConfig {Object}
Объект с локальными настройками, которые будут переопределять свойства объекта взятого из ClusterConfig.


### `async getAllSettings()`
Метод для получения всех настроек кластер конфига.

### `async getSettingsByPrefix(prefix)`

###### prefix {string|required}
Префикс настройки


### `async update()`
Метод обновления настроек. После его вызова настройки будут обнавляться по указанному в конструкторе интервалу.


### `clearInterval()`
Метод останавливающий обновлние настроек по интервалу.

### `async waitForInitialization()`
Метод для ожидания инициализации кластер конфига.

---
_Source: https://npm.io/package/@skbkontur/cluster-config-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._