glitr-router-client v0.0.8

glitr-router-client

example

glitr-router-client implements functionality on the a connected client to allow it to function as a router networked to the server. this means that the server is able to make requests similar to when a webapp makes a HTTP GET request to a server using some tool like isomorphic-fetch.

./grClient.js

import GlitrRouterClient from '..';

const routes = [
    {
        path: '/route-on-client',
        method: 'post',
        handler: [
            (req, res, next) => {
                console.log('[client-side] router working');
                console.log('--- message from server');
                console.log(req.body);
                console.log('---');
                next();
            },
            (req, res, next) => {
                console.log('[client-side] socket middleware works as expected');
                res.send('message from CLIENT to SERVER in response');
            }
        ]
    }
];

const options = {
    namespace: 'testing', // optional: default = ''
    requestTimeout: 10000, // optional: default = 10000
    reactNative: false // required `true` for react-native
};

const grClient = new GlitrRouterClient(routes, options);
grClient.listen('http://localhost:1234', () => {
    console.log('client is now connected');
});

export default grClient;

the glitr-routes constructor takes 2 arguaments:

• routes
• options

routes:

an array of objects:

when creating handler methods for socket.io, if the request header callback property from the server is set to true, the handlers methods must respond back to the client.

the handler response object has a few helper methods to help with this:

all these response methods take 2 parametes i.e. res.send(data, headers). both parametes are options. data is the payload to send, headers is an object to pass additional data in the headers. you can assign a value to headers.status to sent to the client to ovverride the default status code mentioned in the previous table.

if the request takes longer than the timeout period specified in options, an exception will be thrown indicating timeout. you can handle this like a typical promise exception: promise.catch(console.log).

options

an object containing the following attributes:

Usage

when a new instance of glitr-router-client is created, the instance exposes the following objects:

HTTP event emitters

The event emitter methods mentioned in the previous table, are methods used to communicate with the server.

import GlitrRouterClient from 'glitr-router-client';

const grClient = new GlitrRouterClient(routes, options);
grClient.listen('http://localhost:1234', () => {
    console.log('client is now connected');
});

// grClient.get(path, payload, headers)
// grClient.post(path, payload, headers)
// grClient.put(path, payload, headers)
// grClient.delete(path, payload, headers)

Request

when making a request through HTTP by specifying headers.http = true, glitr-router-client will use isophomic-fetch internally to make the request. if you want to specify http headers, simply add them to the headers object. to see what header options are available see fetch docs.

Response

when callback is set to true in the headers of a request, the method will return a promise object with data sent back from the server like you would expect for any regular request over HTTP protocol.

when using socket.io to make the request, the response object properties are described in the following table.

when using express to make the request, the response object is described on the expressjs docs

Example

import grClient from './grClient';

grClient.post('/send-message',
    {
        message: 'hello world',
        recipient: 'clark'
    }, {
        callback: true
    }
).then((dataFromServer) => {
    // process dataFromServer here ...
    console.log(dataFromServer);
});

for more details about the server-side implmentation see glitr-router.