braker-client

cloud-client

Usage

ResourceClient

import CloudClient from 'cloud-client';

import * as resourceInterface from './ResourceInterface';

const SERVICE_NAME = 'a-service';
const cClient = new CloudClient(SERVICE_NAME, resourceInterface);

//set health check.
cClient.setHealthCheck(resourceInterface.checkHealth);

//register http request api.
export default cClient.registerApi();

ResourceInterface

import rp from 'request-promise';

/**
 * Check the service's health status.
 */
export function checkHealth() {
    return rp({
        method: 'get',
        url: `/${SERVICE_NAME}/health`,
        headers: {
            'Content-Type': 'application/json'
        }
    });
}

export function getResource(id) {
    return rp({
        method: 'get',
        url: `/${SERVICE_NAME}/v1/resources/:id`,
        params: {id: id},
        headers: {
            'Content-Type': 'application/json'
        }
    });
}

You can use cloud client to invoke resource interface's function. example is

import resourceClient from './ResourceClient';

resourceClient.getResource(id);

API

new CloudClient(serviceName, interface, options)

serviceName

The service name.

interface

The key-value object for sending request.

options

• logger: Default is console. you can use any other logger that implements logger.log function.
• Other options param is the same as brakes

cClient.setHealthCheck(callback)

Set a callback, when the circuit is open, the callback will be used for checking the service's health status, if the status is ok, the circuit will close.

cClient.registerApi()

return cClient.registerApi();