pip-clients-quotes-node
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

Pip.Services Logo
Quotes Microservice Client SDK for Node.js

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

Quick Links:

Install

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

{
    ...
    "dependencies": {
        ....
        "pip-clients-quotes-node": "^2.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-quotes-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.QuotesHttpClientV1(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

// Create a new quote
var quote = {
    text: { en: 'Get in hurry slowly' },
    author: { en: 'Russian proverb' },
    tags: ['time management'],
    status: 'completed'
};
 
client.createQuote(
    null,
    quote,
    function (err, quote) {
        ...
    }
);
// Get the list of quotes on 'time management' topic
client.getQuotes(
    null,
    {
        tags: 'time management',
        status: 'completed'
    },
    {
        total: true,
        skip: 0,
        take: 10
    },
    function(err, page) {
    ...    
});

Acknowledgements

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

Package Sidebar

Install

npm i pip-clients-quotes-node

Weekly Downloads

2

Version

1.1.1

License

MIT

Unpacked Size

67.5 kB

Total Files

50

Last publish

Collaborators

  • seroukhov