Message Distribution Microservice Client SDK for Node.js
This is a Node.js client SDK for pip-services-msgdistribution microservice. It provides an easy to use abstraction over communication protocols:
- HTTP client
- Seneca client (see http://www.senecajs.org)
- Direct client for monolythic deployments
- Null client to be used in testing
In addition to the microservice functionality the client SDK supports message templates that can be configured by client user.
Install
Add dependency to the client SDK into package.json file of your project
... "dependencies": ... "pip-clients-msgdistribution-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 = 'pip-clients-msgdistribution-node';
Define client configuration parameters.
// Client configurationvar config = parameters: server_url: 'http://localhost:3000' client_url: 'http://localhost:8000' client_name: 'PipServices Sample' welcome_message: 'Congratulations with your signup in <%= clientName %>!' signature: 'Sincerely, <%= clientName %> Team' 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
// Send email message to addressclient;
// Send email message to usersclient;
To use templates for sent messages you need to put template files under configured template folder. Inside template you shall use <%= property %> syntax to insert properties from provided content defined in client configuration and request parameters.
Example of message.txt template
Hello <%= user_name %>! This is a test message from <%= client_name %> sent on <%= today %>.Please, ignore it.
Example of message.html template
Hello <%= user_name %>!This is a test message from <%= client_name %> sent on <%= today %>. Please, ignore it.
Now you can send a message using the templates stored in files. subjectTemplate, textTemplate and htmlTemplate parameters shall contain the template file paths. Client will automatically load their content and parse.
// Send email message to address using templateclient;
Acknowledgements
This client SDK was created and currently maintained by Sergey Seroukhov.