Code example:

let pFilter = require('paranoid-filter');

// Get lists with request to the list server
pFilter.lists.init()
    .then(() => {
        console.log('Got lists');

        // Filter your string
        // res value is an array with filter result info.
        // res is an array of various length for different situations
        let res = pFilter.filter(yourString);
    
        // Stop listen lists refreshings and quit script
        lists.stop();
    });

Requires config package with specified properties:

{
    // ...
    lists: {
        url:    <string>, // key-filter-server url
        secret: <string>  // key-filter-server secret 
    }
    // ...
}

Requires config package with specified properties:

pFilter.filter filter string. Return false if ok, return array if fail

pFilter.lists return Promise. Done when got filter lists. Run lists update subscription pFilter.stop stop lists update subscription