Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.51 KB

readme.md

File metadata and controls

65 lines (41 loc) · 1.51 KB

cuss Build Status

Map of 1700+ profanities to sureness rating. This rating does not represent how vulgar a term is, instead, how likely it is to be used as either profanity or clean text.

Installation

npm:

npm install cuss

Usage

var cuss = require('cuss');

console.log(Object.keys(cuss).length); // 1768

console.log(cuss.beaver); // 0
console.log(cuss.asshat); // 2

API

cuss

Type: Object.<number>cuss exposes a dictionary of phrases to ratings, where each phrase stems from profanities, and each rating is a number between 0 and 2 (both including), representing the certainty the word is used as a profanity depending on context.

Rating Use as a profanity Use in clean text Example
2 likely unlikely asshat
1 maybe maybe addict
0 unlikely likely beaver

Support

cuss supports 1768 English profane words and phrases from profanities.

License

MIT © Titus Wormer