DefinitelyTyped/types/cuss/index.d.ts
Piotr Błażejewicz (Peter Blazejewicz) 687a62f7db
update(cuss): minor version bump (#45665)
- v1.20
- test updated
- DT header minor change

https://github.com/words/cuss/releases/tag/1.20.0

Thanks!
2020-06-28 04:00:02 -04:00

24 lines
768 B
TypeScript

// Type definitions for cuss 1.20
// Project: https://github.com/words/cuss#readme
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/** how likely it is to be used as either profanity or clean text */
type SurenessRating = 0 | 1 | 2;
type Cuss = object & {
/**
* Map of profanities to sureness rating
*/
[phrase: string]: SurenessRating;
};
/**
* `cuss` is a dictionary of phrases to ratings (Object.<number>), where each key can be considered a profanity,
* and each rating is a number between 0 and 2 (both including),
* representing the certainty the key is used as a profanity depending on context.
*/
declare const cuss: Cuss;
export = cuss;