@fakerjs/faker/index.d.ts

A set of javascript packages that generates fake data for you.

interface OptionsInteger {
    min?: number;
    max?: number;
}
interface OptionsFloat {
    min?: number;
    max?: number;
    fixed?: number;
}
interface OptionsAge {
    type?: string;
}
interface OptionsAnimal {
    type?: string;
    locale?: string;
}
interface OptionsGender {
    locale?: string;
    extra?: string[];
}
interface OptionsLetter {
    casing?: string;
    locale?: string;
}
interface OptionsString {
    length?: number;
    keyspace?: string;
}
interface OptionsProfession {
    rank?: boolean;
    locale?: string;
}
interface OptionsWord {
    length?: number;
}
interface OptionsSentence {
    words?: number;
}
interface OptionsParagraph {
    sentences?: number;
    wordsMin?: number;
    wordsMax?: number;
}
interface OptionsDomain {
    tld?: string;
}
interface OptionsEmail {
    domain?: string;
}
interface OptionsFirstname {
    locale?: string;
    gender?: string;
}
interface OptionsLastname {
    locale?: string;
}
interface OptionsUrl {
    protocol?: string;
    tld?: string;
}
interface OptionsGame {
    locale?: string;
}
interface OptionsHouse {
    locale?: string;
}
interface OptionsSport {
    locale?: string;
}
interface OptionsFaker {
    locale?: string;
}
declare class Faker {
    _options?: OptionsFaker;
    boolean(): boolean;
    integer(options?: OptionsInteger): number;
    float(options?: OptionsFloat): number;
    age(options?: OptionsAge): number;
    animal(options?: OptionsAnimal): string;
    gender(options?: OptionsGender): string;
    ip(): string;
    letter(options?: OptionsLetter): string;
    string(options?: OptionsString): string;
    profession(options?: OptionsProfession): string;
    superhero(): string;
    word(options?: OptionsWord): string;
    sentence(options?: OptionsSentence): string;
    paragraph(options?: OptionsParagraph): string;
    domain(options?: OptionsDomain): string;
    url(options?: OptionsUrl): string;
    browser(): string;
    tld(): string;
    email(options?: OptionsEmail): string;
    firstName(options?: OptionsFirstname): string;
    lastName(options?: OptionsLastname): string;
    game(options?: OptionsGame): any;
    house(options?: OptionsHouse): any;
    sport(options?: OptionsSport): any;
    blood(): any;
}
export default function faker(options?: OptionsFaker): Faker;