client-search-node

Search 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
• Direct client for monolythic deploments
• 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-search-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-search-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 = new SearchHttpClientV1();

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

// Work with the microservice
...

Now the client is ready to perform operations

// Create a new search record
let record = {
    id: '1',
    type: 'Test type1',
    name: 'Test name 1',
    time: new Date(2014, 1, 1),
    description: 'description1',
    refs: [
        {
            id: '1',
            type: 'type1',
            name: 'name1',
            parent: true,
            subtype: 'subtype1'
        }
    ],
    tags: ['black']
};

record = await client.setRecord(
    null,
    record
);

// Get the list of search records
let page = await client.getRecords(
    null,
    {
        type: 'Test type1',
        name: 'Test name 1'
    },
    {
        total: true,
        skip: 0,
        take: 10
    }
);

Acknowledgements

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