1.1.5 • Published 2 years ago

badword-filter v1.1.5

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Bad Word Filter for EN && TR lang words

Coverage Badge

You may filter quickly your strings in a couple steps. You can check is provided string is valid ? or you can simply replace bad word with given character.(You can use swear words list only for English language for now.)

Related Functions

You can import related functions as follows;

import { checkIsValid, replaceWordWith } from 'badword-filter';

checkIsValid

This function takes two args and returns boolean as validation result. You can use swear words list only for English language for now.

const ValidationOptions: object = {
  swear: boolean,
  negative: boolean,
  political: boolean,
  religions: boolean,
};

checkIsValid('word', ValidationOptions);
ParameterTypeDescription
datastringRequired. Your string to validate.
ValidationOptionsobjectRequired. Your wished badword list types.

replaceWordWith

This function takes three args and returns masked string with given pattern as validation result. You can use swear words list only for English language for now.

const ValidationOptions: object = {
  swear: boolean,
  negative: boolean,
  political: boolean,
  religions: boolean,
};
replaceWordWith('word', '*', ValidationOptions);
ParameterTypeDescription
datastringRequired. Your string to validate.
replacementCharacterstringRequired. Your special character using as replacer.
ValidationOptionsobjectRequired. Your wished badword list types.

Demo

Authors

LICENCE

MIT License

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.0.33

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.32

3 years ago

1.0.31

3 years ago

1.0.30

3 years ago

1.0.29

3 years ago

1.0.28

3 years ago

1.0.27

3 years ago

1.0.26

3 years ago

1.0.25

3 years ago

1.0.24

3 years ago

1.0.22

3 years ago

1.0.21

3 years ago

1.0.20

3 years ago

1.0.19

3 years ago

1.0.18

3 years ago

1.0.17

3 years ago

1.0.16

3 years ago

1.0.15

3 years ago

1.0.14

3 years ago

1.0.13

3 years ago

1.0.12

3 years ago

1.0.11

3 years ago

1.0.10

3 years ago

1.0.9

3 years ago

1.0.8

3 years ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago