warui v0.2.0

Warui

A JavaScript library to detect bad words. It uses the Urban Dictionary API and a built in dictionary.

Usage

Warui requires axios to work.

Install as an npm package

npm install --save axios warui

Then import or require the instance.

or via CDN

https://unpkg.com/warui
https://unpkg.com/axios

Then use as Warui or window.Warui

API

Warui.classify(term: String, threshold: Number): Promise<Boolean> Classify is an async function

License

Released under MIT