Blobs Microservice Client SDK for Node.js
This is a Node.js client SDK for pip-services-storage microservice. It provides an easy to use abstraction over communication protocols:
- HTTP/REST client
- Seneca client (see http://www.senecajs.org)
- AWS Lambda client
- Direct client for monolythic deploments
- S3 client to work with S3 storage directly
- Null client to be used in testing
Install
Add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"pip-clients-blobs-node": "^1.0.*",
...
}
}Then install the dependency using npm tool
# Install new dependencies
npm install
# Update already installed dependencies
npm updateUse
Inside your code get the reference to the client SDK
var sdk = new require('pip-clients-blobs-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.StorageRestClient(config);
// Connect to the microservice
client.open(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 picture
var blob = {
group: "pictures",
name: "google_search.jpg"
};
client.createBlobFromUrl(
null,
blob,
"https://www.google.com/logos/doodles/2016/doodle-4-google-2016-us-winner-5664555055185920-hp.jpg",
function (err, blob) {
...
}
);// Start reading blobs in chunks
client.getBlobDataById(
null,
blob_id,
function(err, blob, data) {
...
}
);Acknowledgements
This client SDK was created and currently maintained by Sergey Seroukhov.
