jabber
Version:
Simple random word, paragraph, lorem ipsum, dummy text generator, fake name, email.
53 lines (52 loc) • 1.52 kB
TypeScript
/**
*
* Jabber, tiny library to generate random real like words / sentences lipsum / lorem ipsum
*
*
*/
/**
* Jabber Class
* class definition
*/
declare class Jabber {
/**
*
* @param themeWords {array} Custom words that need to appear in some density
* @param themeWordDensity {number} appearance of themeword 1 per this number so 5 will make it approx 1 per 5 words
* @param extraVowels {string} additional vowel chars
* @param extraConsonants {string} additional consonants
*/
themeWords: string[];
themeWordDensity: number;
vowels: string;
consonants: string;
constructor(themeWords?: string[], themeWordDensity?: number, extraVowels?: string, extraConsonants?: string);
/**
* Create word of certain length
* @param length
* @param capitalize {boolean}
* @param avoidThemeWords {boolean}
* @returns {string}
*/
createWord(length: number, capitalize?: boolean, avoidThemeWords?: boolean): string;
/**
* Create paragraph of certain number of words
* @param length
* @returns {string}
*/
createParagraph(length: number): string;
/**
* Create fake full name
* @param salutation {boolean}
* @returns {string}
*/
createFullName(salutation?: boolean): string;
/**
* Create email
* @param customDomain {string}
* @returns {string}
*/
createEmail(customDomain?: string): string;
_jsUcfirst(str: string): string;
}
export default Jabber;