Package Exports

pip-clients-settings-node

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pip-clients-settings-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Settings Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-settings microservice. It provides an easy to use abstraction over communication protocols:

HTTP/REST client
Seneca client (see http://www.senecajs.org)
Null client to be used in testing

Quick Links:

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-settings-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-settings-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.SettingsHttpClientV1(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

var parameters = {
    myapp: {
        theme: 'blue',
        language: 'en'
    }
};

// Sets section parameters
client.setSection(
    null,
    '123',
    parameters,
    function (err, parameters) {
        ...
    }
);

// Get section parameters
client.getSectionById(
    null,
    '123',
    function(err, parameters) {
    ...    
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.