client-announcements-node v1.1.0

Announcements Microservice Client SDK for Node.js

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

• HTTP client
• AWS Lambda client
• Direct client

Quick Links:

• Development Guide
• API Version 1

Install

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

{
    ...
    "dependencies": {
        ....
        "client-announcements-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

let sdk = new require('client-announcements-node');

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

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

Instantiate the client and open connection to the microservice

// Create the client instance
let client = sdk.AnnouncementsHttpClientV1(config);

// Connect to the microservice
await client.open(null);

// Work with the microservice
...

Now the client is ready to perform operations

// Create a new announcement
let announcement = await client.createAnnouncement(
    null,
    { 
        category: 'maintenance',
        title: { en: 'Maintenance on Jan 01' },
        content: { en: 'Our servers will be shutdown for maintenance on Jan 01' }
    }
);

// Get a random announcement
announcement = await client.getRandomAnnouncement(
    null,
    {}
);

Acknowledgements

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