UNPKG

@alixmixx/unique-username-generator

Version:

A package to generate a unique username from email or randomly selected nouns and adjectives. User can add a separator between the username, define the maximum length of a username and adds up to six random digits.

21 lines (20 loc) 727 B
export declare enum Style { LowerCase = "lowerCase", UpperCase = "upperCase", Capital = "capital", CamelCase = "camelCase", SnakeCase = "snakeCase", KebabCase = "kebabCase", PascalCase = "pascalCase" } export interface Config { dictionaries: string[][]; separator?: string; randomDigits?: number; length?: number; style?: Style; } export declare function generateFromEmail(email: string, randomDigits?: number): string; export declare function generateUsername(separator?: string, randomDigits?: number, length?: number, prefix?: string, style?: Style): string; export declare function uniqueUsernameGenerator(config: Config): string; export { adjectives, nouns } from "./data";