namecrafter/dist/nameGenerator.d.ts

Generate random names - full names or individual first, middle, and last names

/**
 * A class that provides methods for generating random names
 */
export declare class NameGenerator {
    /**
     * Generates a random first name
     * @returns {string} A randomly generated first name
     * @example
     * ```typescript
     * // As a static method
     * import { NameGenerator } from 'namecrafter';
     * const firstName = NameGenerator.randomFirstName(); // e.g. "John"
     *
     * // Or with an instance
     * const generator = new NameGenerator();
     * const firstName = generator.randomFirstName();
     * ```
     */
    static randomFirstName(): string;
    /**
     * Generates a random middle name
     * @returns {string} A randomly generated middle name
     * @example
     * ```typescript
     * // As a static method
     * import { NameGenerator } from 'namecrafter';
     * const middleName = NameGenerator.randomMiddleName(); // e.g. "Michael"
     *
     * // Or with an instance
     * const generator = new NameGenerator();
     * const middleName = generator.randomMiddleName();
     * ```
     */
    static randomMiddleName(): string;
    /**
     * Generates a random last name
     * @returns {string} A randomly generated last name
     * @example
     * ```typescript
     * // As a static method
     * import { NameGenerator } from 'namecrafter';
     * const lastName = NameGenerator.randomLastName(); // e.g. "Smith"
     *
     * // Or with an instance
     * const generator = new NameGenerator();
     * const lastName = generator.randomLastName();
     * ```
     */
    static randomLastName(): string;
    /**
     * Instance method for generating a random first name
     */
    randomFirstName(): string;
    /**
     * Instance method for generating a random middle name
     */
    randomMiddleName(): string;
    /**
     * Instance method for generating a random last name
     */
    randomLastName(): string;
    /**
     * Generates a random full name consisting of a first name, middle name, and last name
     * @returns {string} A randomly generated full name
     * @example
     * ```typescript
     * import { NameGenerator } from 'namecrafter';
     * const generator = new NameGenerator();
     * const name = generator.randomName(); // e.g. "John Michael Smith"
     * ```
     */
    randomName(): string;
}
export default NameGenerator;
export declare const randomFirstName: typeof NameGenerator.randomFirstName;
export declare const randomMiddleName: typeof NameGenerator.randomMiddleName;
export declare const randomLastName: typeof NameGenerator.randomLastName;