A JavaScript client library for interacting with the Configleam service, providing an easy-to-use interface for fetching configuration data.

Note: If you're looking for the main Configleam project, which provides the backend service, it is located here.

Installation

You can install the Configleam JavaScript client via npm:

npm install configleam-js-client

Usage

import { Configleam, ConfigleamOptions } from 'configleam-js-client';

// Create a Configleam instance
const options: ConfigleamOptions = {
  addrs: 'https://example.com/configleam',
};

const configleam = new Configleam(options);

// Read configuration
const params = {
  env: 'development',
  groups: ['api-product'],
  globals: ['redis', 'mongo'],
};

const config = await configleam.readConfig(params);
console.log(config);

Configuration Options

• addrs: The base URL of the Configleam service.

API

Configleam(options: ConfigleamOptions)

Creates a new instance of the Configleam client with the specified options.

readConfig(params: ReadConfigParam, options?: ReadConfigOptions): Promise<ConfigleamConfig>

Fetches configuration data from the Configleam service endpoint.

• params: An object containing parameters for fetching configuration data (e.g., environment, groups, globals).
• options (optional): Additional options for the request, such as custom headers.

Contributing

Contributions are welcome! Please see the Contribution Guidelines for more information.

Bug Reports and Feature Requests

Please report any issues or feature requests on the Issue Tracker.

License

This project is licensed under the MIT License.

Contact

LinkedIn [Mykhaylo Gusak] - [email protected]

Project Link: https://github.com/raw-leak/configleam-js-client