Message Templates Microservice Client SDK for Node.js
This is a Node.js client SDK for pip-services-msgtemplates microservice. It provides an easy to use abstraction over communication protocols:
- Direct client
- HTTP client
- Seneca client (see http://www.senecajs.org)
- AWS Lambda client (see https://aws.amazon.com/lambda)
- Null client to be used in testing
- Message template resolver
Install
Add dependency to the client SDK into package.json file of your project
... "dependencies": ... "pip-clients-msgtemplates-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 = 'pip-clients-msgtemplates-node';
Define client configuration parameters that match configuration of the microservice external API
// Client configurationvar config = connection: protocol: 'http' host: 'localhost' port: 8080 ;
Instantiate the client and open connection to the microservice
// Create the client instancevar client = sdk; // Connect to the microserviceclient;
Now the client is ready to perform operations
// Create a new msgtemplatevar template = name: 'Welcome' subject: en: 'Welcome to our product' text: en: 'Welcome <%= name %>!' html: en: '<h1>Welcome <%= name %>!<h1>' status: 'completed'; client;
// Get welcome message templateclient;
Acknowledgements
This client SDK was created and currently maintained by Sergey Seroukhov.