rousseau

var rousseau = require("rousseau");
 
rousseau('So the cat was stolen.', function(err, results) {
    ...
});

{
    // Type of check that output this suggestion
    type: "so",
 
    // Level of importance
    // "suggestion", "warning", "error"
    level: "warning",
 
    // Index in the text
    index: 10,
 
    // Size of the section in the text
    offset: 2,
 
    // Message to describe the suggestion
    message: "omit 'So' from the beginning of sentences",
 
    // Replacements suggestion
    replacements: [
        {
            value: ""
        }
    ]
}

rousseau("Some text", {
    checks: {
        spelling: rousseau.tokenize.check([
            rousseau.tokenize.words(),
            rousseau.filter(function(word) {
                return wordIsValid(word);
            }),
            rousseau.define({
                level: rousseau.levels.ERROR,
                message: "Spelling error"
            })
        ])
    }
}, function(err, results) {
    ...
})
 

rousseau('So the cat was stolen.', {
    cache: 100 // A maximum of 100 elements will be stored in the memory cache
}, function(err, results) {
    ...
});