Giter Club home page Giter Club logo

lfg-filter's Introduction

lfg-filter

This is a NodeCG bundle.

Build Status

This bundle provides wordfilter and emailfilter objects that other bundles can use to check if a string contains profanity or if an email address is blacklisted. It also has a dashboard panel that allows the end user to add and remove phrases from the blacklists. By default, the blacklists are empty.

Installation

  • Install to nodecg/bundles/lfg-filter
  • Run NodeCG, open your dashboard, and use the Filter panel to edit the blacklists

Usage

Add lfg-filter as a bundleDependency in your bundle's nodecg.json

Then add the following to your bundle's extension:

var wordfilter = nodecg.extensions['lfg-filter'].wordfilter;
var emailfilter = nodecg.extensions['lfg-filter'].emailfilter;

// Returns 'true' if the string contains profanity
if (wordfilter.blacklisted('this is a string')) {
    console.log('bad words found');
} else {
    console.log('squeaky clean');
}

// Returns 'true' if the address is blacklisted
if (emailfilter.blacklisted('[email protected]')) {
    console.log('email blacklisted');
} else {
    console.log('looks good to me, chief');
}

License

lfg-filter is provided under the MIT license, which is available to read in the [LICENSE][] file. [license]: LICENSE

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.