declarations/faker/faker.d.ts

[](https://www.npmjs.com/package/declarations)

// Type definitions for faker
// Project: http://marak.com/faker.js/
// Definitions by: Bas Pennings <https://github.com/basp/>, Yuki Kokubun <https://github.com/Kuniwak>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare var fakerStatic: Faker.FakerStatic;

declare namespace Faker {
	interface FakerStatic {
		locale: string;

		address: {
			zipCode(format?: string): string;
			city(format?: number): string;
			cityPrefix(): string;
			citySuffix(): string;
			streetName(): string;
			streetAddress(useFullAddress?: boolean): string;
			streetSuffix(): string;
			streetPrefix(): string;
			secondaryAddress(): string;
			county(): string;
			country(): string;
			countryCode(): string;
			state(useAbbr?: boolean): string;
			stateAbbr(): string;
			latitude(): string;
			longitude(): string;
		};

		commerce: {
			color(): string;
			department(): string;
			productName(): string;
			price(min?: number, max?: number, dec?: number, symbol?: string): string;
			productAdjective(): string;
			productMaterial(): string;
			product(): string;
		};

		company: {
			suffixes(): string[];
			companyName(format?: number): string;
			companySuffix(): string;
			catchPhrase(): string;
			bs(): string;
			catchPhraseAdjective(): string;
			catchPhraseDescriptor(): string;
			catchPhraseNoun(): string;
			bsAdjective(): string;
			bsBuzz(): string;
			bsNoun(): string;
		};

		date: {
			past(years?: number, refDate?: string|Date): Date;
			future(years?: number, refDate?: string|Date): Date;
			between(from: string|number|Date, to: string|Date): Date;
			recent(days?: number): Date;
			month(options?: { abbr?: boolean, context?: boolean }): string;
			weekday(options?: { abbr?: boolean, context?: boolean }): string;
		};

		fake(str: string): string;

		finance: {
			account(length?: number): string;
			accountName(): string;
			mask(length?: number, parens?: boolean, elipsis?: boolean): string;
			amount(min?:number, max?: number, dec?: number, symbol?: string): string;
			transactionType(): string;
			currencyCode(): string;
			currencyName(): string;
			currencySymbol(): string;
		};

		hacker: {
			abbreviation(): string;
			adjective(): string;
			noun(): string;
			verb(): string;
			ingverb(): string;
			phrase(): string;
		};

		helpers: {
			randomize<T>(array: T[]): T;
			randomize(): string;
			slugify(string?: string): string;
			replaceSymbolWithNumber(string?: string, symbol?: string): string;
			replaceSymbols(string?: string): string;
			shuffle<T>(o: T[]): T[];
			shuffle(): string[];
			mustache(str: string, data: { [key: string]: string|((substring: string, ...args: any[]) => string) }): string;
			createCard(): Faker.Card;
			contextualCard(): Faker.ContextualCard;
			userCard(): Faker.UserCard;
			createTransaction(): Faker.Transaction;
		};


		image: {
			image(): string;
			avatar(): string;
			imageUrl(width?: number, height?: number, category?: string): string;
			abstract(width?: number, height?: number): string;
			animals(width?: number, height?: number): string;
			business(width?: number, height?: number): string;
			cats(width?: number, height?: number): string;
			city(width?: number, height?: number): string;
			food(width?: number, height?: number): string;
			nightlife(width?: number, height?: number): string;
			fashion(width?: number, height?: number): string;
			people(width?: number, height?: number): string;
			nature(width?: number, height?: number): string;
			sports(width?: number, height?: number): string;
			technics(width?: number, height?: number): string;
			transport(width?: number, height?: number): string;
		};

		internet: {
			avatar(): string;
			email(firstName?: string, lastName?: string, provider?: string): string;
			userName(firstName?: string, lastName?: string): string;
			protocol(): string;
			url(): string;
			domainName(): string;
			domainSuffix(): string;
			domainWord(): string;
			ip(): string;
			userAgent(): string;
			color(baseRed255?: number, baseGreen255?: number, baseBlue255?: number): string;
			mac(): string;
			password(len?: number, memorable?: boolean, pattern?: string|RegExp, prefix?: string): string;
		};

		lorem: {
			words(num?: number): string;
			sentence(wordCount?: number, range?: number): string;
			sentences(sentenceCount?: number): string;
			paragraph(sentenceCount?: number): string;
			paragraphs(paragraphCount?: number, separator?: string): string;
		};

		name: {
			firstName(gender?: number): string;
			lastName(gender?: number): string;
			findName(firstName?: string, lastName?: string, gender?: number): string;
			jobTitle(): string;
			prefix(): string;
			suffix(): string;
			title(): string;
			jobDescriptor(): string;
			jobArea(): string;
			jobType(): string;
		};

		phone: {
			phoneNumber(format?: string): string;
			phoneNumberFormat(phoneFormatsArrayIndex?: number): string;
			phoneFormats(): string;
		};

		random: {
			number(max: number): number;
			number(options?: { min?: number, max?: number, precision?: number }): number;
			arrayElement(): string;
			arrayElement<T>(array: T[]): T;
			objectElement(object?: { [key: string]: any }, field?: "key"): string;
			objectElement<T>(object?: { [key: string]: T }, field?: any): T;
			uuid(): string;
			boolean(): boolean;
		};

		seed(value: number): void;
	}

	interface Card {
		name: string;
		username: string;
		email: string;
		address: FullAddress;
		phone: string;
		website: string;
		company: Company;
		posts: Post[];
		accountHistory: string[];
	}

	interface FullAddress {
		streetA: string;
		streetB: string;
		streetC: string;
		streetD: string;
		city: string;
		state: string;
		county: string;
		zipcode: string;
		geo: Geo;
	}

	interface Geo {
		lat: string;
		lng: string;
	}

	interface Company {
		name: string;
		catchPhrase: string;
		bs: string;
	}

	interface Post {
		words: string;
		sentence: string;
		sentences: string;
		paragraph: string;
	}

	interface ContextualCard {
		name: string;
		username: string;
		email: string;
		dob: Date;
		phone: string;
		address: Address;
		website: string;
		company: Company;
	}

	interface Address {
		street: string;
		suite: string;
		city: string;
		state: string;
		zipcode: string;
		geo: Geo;
	}

	interface UserCard {
		name: string;
		username: string;
		email: string;
		address: Address;
		phone: string;
		website: string;
		company: Company;
	}

	interface Transaction {
		amount: string;
		date: Date;
		business: string;
		name: string;
		type: string;
		account: string;
	}
}

declare module "faker" {
	export = fakerStatic;
}

declare module "faker/locale/de" {
	export = fakerStatic;
}

declare module "faker/locale/de_AT" {
	export = fakerStatic;
}

declare module "faker/locale/de_CH" {
	export = fakerStatic;
}

declare module "faker/locale/el_GR" {
	export = fakerStatic;
}

declare module "faker/locale/en" {
	export = fakerStatic;
}

declare module "faker/locale/en_AU" {
	export = fakerStatic;
}

declare module "faker/locale/en_BORK" {
	export = fakerStatic;
}

declare module "faker/locale/en_CA" {
	export = fakerStatic;
}

declare module "faker/locale/en_GB" {
	export = fakerStatic;
}

declare module "faker/locale/en_IE" {
	export = fakerStatic;
}

declare module "faker/locale/en_IND" {
	export = fakerStatic;
}

declare module "faker/locale/en_US" {
	export = fakerStatic;
}

declare module "faker/locale/en_au_ocker" {
	export = fakerStatic;
}

declare module "faker/locale/es" {
	export = fakerStatic;
}

declare module "faker/locale/es_MX" {
	export = fakerStatic;
}

declare module "faker/locale/fa" {
	export = fakerStatic;
}

declare module "faker/locale/fr" {
	export = fakerStatic;
}

declare module "faker/locale/fr_CA" {
	export = fakerStatic;
}

declare module "faker/locale/ge" {
	export = fakerStatic;
}

declare module "faker/locale/it" {
	export = fakerStatic;
}

declare module "faker/locale/ja" {
	export = fakerStatic;
}

declare module "faker/locale/ko" {
	export = fakerStatic;
}

declare module "faker/locale/nb_NO" {
	export = fakerStatic;
}

declare module "faker/locale/nep" {
	export = fakerStatic;
}

declare module "faker/locale/nl" {
	export = fakerStatic;
}

declare module "faker/locale/pl" {
	export = fakerStatic;
}

declare module "faker/locale/pt_BR" {
	export = fakerStatic;
}

declare module "faker/locale/ru" {
	export = fakerStatic;
}

declare module "faker/locale/sk" {
	export = fakerStatic;
}

declare module "faker/locale/sv" {
	export = fakerStatic;
}

declare module "faker/locale/tr" {
	export = fakerStatic;
}

declare module "faker/locale/uk" {
	export = fakerStatic;
}

declare module "faker/locale/vi" {
	export = fakerStatic;
}

declare module "faker/locale/zh_CN" {
	export = fakerStatic;
}

declare module "faker/locale/zh_TW" {
	export = fakerStatic;
}