f-ck

Clean-up cuss (c*ss, c**s, @#$%) words.

Not affiliated with Football Club København.

Installation

npm:

npm install f-ck

Usage

var fck = require('f-ck');

console.log(fck('butt')); //=> 'b*tt'
console.log(fck.vowel('butt')); //=> 'b*tt'
console.log(fck.inner('butt')); //=> 'b**t'
console.log(fck.grawlix('butt')); //=> '@#$%'
console.log(fck.grawlix(7)); //=> '@#$%!&?'

console.log(fck('butt', '-')); //=> 'b-tt'

API

fck(value[, character])

fck.vowel(value[, character])

Sanitise value by replacing vowels in value with character (default: '*').

fck.inner(value[, character])

Sanitise value by replacing all characters except the first and last in value with character (default: '*').

fck.grawlix(value[, pattern])

Sanitise value using a grawlix pattern (default: '@#$%!&?'). Essentially, repeats pattern for value (when number) / value.length (when string) characters.

License

MIT © Titus Wormer