toguru-client

Toguru Client for Node.js

$ yarn add toguru-client

Javascript version

Usage with plain Node

const ToguruClient = require('toguru-client');
const client = ToguruClient({
    endpoint: 'https://example.com/togglestate',
    refreshInterval: 60 * 1000, // 1 minute
});
 
const user1 = {
    uuid: 'ad89f957-d646-1111-1111-a02c9aa7faba',
    culture: 'de-DE',
    forcedToggles: {
        t2: true,
    },
};
 
const user2 = {
    uuid: 'ad89f957-d646-2222-2222-a02c9aa7faba',
    culture: 'de-DE',
};
 
client.isToggleEnabled('t2', user1); // true
client.isToggleEnabled('t1', user2); // true or false
 
client.togglesForService('service', user1);
// { t3: true, qwe: false ... }
 
client.toggleNamesForService('service');
// ['t3', 'qwe']

Usage with express

const toguruClient = require('toguru-client/express');
 
const toguruMiddleware = toguruClient({
    endpoint: 'https://toguru-example.com/',
    cookieName: 'uid',
    queryParameterName: 'toguru',
});
 
app.get('/', toguruMiddleware, (req, res) => {
    if (req.toguru.isOn('toggle-name')) {
        res.send('Toggle is ON');
    } else {
        res.send('Toggle is OFF');
    }
});

Typescript

Client usage:

import ToguruClient from 'toguru-client';
 
const client: ToguruClient.ToguruClientInstance = ToguruClient({
    endpoint: 'https://example.com/togglestate',
    refreshInterval: 60 * 1000, // 1 minute
});
 
const user: ToguruClient.ToguruUser = {
    uuid: 'ad89f957-d646-1111-1111-a02c9aa7faba',
    culture: 'de-DE',
    forcedToggles: {
        t2: true,
    },
};
 
client.isToggleEnabled('test-toggle', user);
client.toggleNamesForService('service');
client.togglesForService('service', user);

Express middleware usage:

import ToguruMiddleware, { ToguruMiddlewareInstance } from 'toguru-client/express';
 
const toguruMdw: ToguruMiddlewareInstance = ToguruMiddleware({
    endpoint: 'https://example.com/togglestate',
    refreshInterval: 60 * 1000, // 1 minute
    cookieName: 'as24Visitor',
    cultureCookieName: 'culture',
});
 
app.get('/toggle-test', toguruMdw, (req: Request, res: Response) => {
    if (req.toguru && req.toguru.isToggleEnabled('a')) {
        res.send(`Yes`);
    } else {
        res.send(`No`);
    }
 
    // req.toguru.isToggleEnabled('name') // true
    // req.toguru.togglesForService('service') // {'service-toggle': true}
    // req.toguru.toggleNamesForService('service-name') // ['service-toggle']
    // req.toguru.toggleStringForService('service-name') // toguru=service-toggle=true|service-toggle-2=false`
});

Development