client-attachments-node

Attachments Microservice Client SDK for Node.js / ES2017

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

• HTTP/REST client
• Seneca client (see http://www.senecajs.org)
• Direct client for monolythic deployments
• Null client to be used in testing

Quick Links:

• Development Guide
• API Version 1

Install

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

{
    ...
    "dependencies": {
        ....
        "client-attachments-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 = new require('client-attachments-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.AttachmentsHttpClientV1(config);

// Connect to the microservice
try {
    await client.open(null);
    // Work with the microservice
    ...
} catch(err) {
    console.error('Connection to the microservice failed');
    console.error(err);
}

Now the client is ready to perform operations

// Add attachments to a document
let attachments = await client.addAttachments(
    null,
    { 
        id: '123',
        type: 'document',
        name: 'My document'
    },
    ['1', '2', '3']
);

var now = new Date();

// Get specific attachment
let attachment = await client.getAttachmentById(
    null,
    '1'
);

Acknowledgements

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