fake

package module
v0.1.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 5, 2025 License: MIT Imports: 10 Imported by: 1

README

📝 Fake - Go Fake Data Generator

This is a fork of the original icrowley/fake with native go:embed support and without global variables.

Key Improvements

  • ✨ Native Go embed (no code generation needed)
  • 🚀 No globals, no mutexes etc...

Features

  • Multi-language support

Installation

go get github.com/dirtymew/fake

Quick Start


func main(){
    f := fake.New()
    fmt.Println(f.FullName())                  // "John Doe" 
    fmt.Println(f.EmailAddress())              // "john.doe@example.com"
}

Requirements

Go 1.24+

Documentation

Index

Constants

View Source 
const (
	LangEnglish = "en"
	LangRussian = "ru"
)
View Source 
const (
	DefaultPasswordMinLength = 6
	DefaultPasswordMaxLength = 12
	HexColorLength           = 6
	HexColorShortLength      = 3
)

Variables

View Source 
var (
	// ErrNoLanguageFn is the error that indicates that given language is not available
	ErrNoLanguageFn = func(lang string) error { return fmt.Errorf("language passed (%s) is not available", lang) }
	// ErrNoSamplesFn is the error that indicates that there are no samples for the given language
	ErrNoSamplesFn = func(lang string) error { return fmt.Errorf("no samples found for language: %s", lang) }
)

Functions

This section is empty.

Types

type Fake 

type Fake struct {
	// contains filtered or unexported fields
}

func New 

func New() *Fake

func (*Fake) Brand 

func (f *Fake) Brand() string

Brand generates brand name

func (*Fake) Character 

func (f *Fake) Character() string

Character generates random character in the given language

func (*Fake) Characters 

func (f *Fake) Characters() string

Characters generates from 1 to 5 characters in the given language

func (*Fake) CharactersN 

func (f *Fake) CharactersN(n int) string

CharactersN generates n random characters in the given language

func (*Fake) City 

func (f *Fake) City() string

City generates random city

func (*Fake) Color 

func (f *Fake) Color() string

Color generates color name

func (*Fake) Company 

func (f *Fake) Company() string

Company generates company name

func (*Fake) Continent 

func (f *Fake) Continent() string

Continent generates random continent

func (*Fake) Country 

func (f *Fake) Country() string

Country generates random country

func (*Fake) CreditCardNum 

func (f *Fake) CreditCardNum(vendor string) string

CreditCardNum generated credit card number according to the card number rules

func (*Fake) CreditCardType 

func (f *Fake) CreditCardType() string

CreditCardType returns one of the following credit values: VISA, MasterCard, American Express and Discover

func (*Fake) Currency 

func (f *Fake) Currency() string

Currency generates currency name

func (*Fake) CurrencyCode 

func (f *Fake) CurrencyCode() string

CurrencyCode generates currency code

func (*Fake) Day 

func (f *Fake) Day() int

Day generates day of the month

func (*Fake) Digits 

func (f *Fake) Digits() string

Digits returns from 1 to 5 digits as a string

func (*Fake) DigitsN 

func (f *Fake) DigitsN(n int) string

DigitsN returns n digits as a string

func (*Fake) DomainName 

func (f *Fake) DomainName() string

DomainName generates random domain name

func (*Fake) DomainZone 

func (f *Fake) DomainZone() string

DomainZone generates random domain zone

func (*Fake) EmailAddress 

func (f *Fake) EmailAddress() string

EmailAddress generates email address

func (*Fake) EmailBody 

func (f *Fake) EmailBody() string

EmailBody generates random email body

func (*Fake) EmailSubject 

func (f *Fake) EmailSubject() string

EmailSubject generates random email subject

func (*Fake) EnFallback 

func (f *Fake) EnFallback(flag bool)

EnFallback sets the flag that allows fake to fallback to englsh samples if the ones for the used languaged are not available

func (*Fake) FemaleFirstName 

func (f *Fake) FemaleFirstName() string

FemaleFirstName generates female first name

func (*Fake) FemaleFullName 

func (f *Fake) FemaleFullName() string

FemaleFullName generates female full name it can occasionally include prefix or suffix

func (*Fake) FemaleFullNameWithPrefix 

func (f *Fake) FemaleFullNameWithPrefix() string

FemaleFullNameWithPrefix generates prefixed female full name if prefixes for the given language are available

func (*Fake) FemaleFullNameWithSuffix 

func (f *Fake) FemaleFullNameWithSuffix() string

FemaleFullNameWithSuffix generates suffixed female full name if suffixes for the given language are available

func (*Fake) FemaleLastName 

func (f *Fake) FemaleLastName() string

FemaleLastName generates female last name

func (*Fake) FemalePatronymic 

func (f *Fake) FemalePatronymic() string

FemalePatronymic generates female patronymic

func (*Fake) FirstName 

func (f *Fake) FirstName() string

FirstName generates first name

func (*Fake) FullName 

func (f *Fake) FullName() string

FullName generates full name it can occasionally include prefix or suffix

func (*Fake) FullNameWithPrefix 

func (f *Fake) FullNameWithPrefix() string

FullNameWithPrefix generates prefixed full name if prefixes for the given language are available

func (*Fake) FullNameWithSuffix 

func (f *Fake) FullNameWithSuffix() string

FullNameWithSuffix generates suffixed full name if suffixes for the given language are available

func (*Fake) Gender 

func (f *Fake) Gender() string

Gender generates random gender

func (*Fake) GenderAbbrev 

func (f *Fake) GenderAbbrev() string

GenderAbbrev returns first downcased letter of the random gender

func (*Fake) GetLangs added in v0.1.2 

func (f *Fake) GetLangs() []string

GetLangs returns a slice of available languages from the embedded data FS.

func (*Fake) HexColor 

func (f *Fake) HexColor() string

HexColor generates hex color name

func (*Fake) HexColorShort 

func (f *Fake) HexColorShort() string

HexColorShort generates short hex color name

func (*Fake) IPv4 

func (f *Fake) IPv4() string

IPv4 generates IPv4 address

func (*Fake) IPv6 

func (f *Fake) IPv6() string

IPv6 generates IPv6 address

func (*Fake) Industry 

func (f *Fake) Industry() string

Industry generates industry name

func (*Fake) JobTitle 

func (f *Fake) JobTitle() string

JobTitle generates job title

func (*Fake) Language 

func (f *Fake) Language() string

Language generates random human language

func (*Fake) LastName 

func (f *Fake) LastName() string

LastName generates last name

func (*Fake) Latitude 

func (f *Fake) Latitude() float32

Latitude generates latitude (from -90.0 to 90.0)

func (*Fake) LatitudeDegrees 

func (f *Fake) LatitudeDegrees() int

LatitudeDegrees generates latitude degrees (from -90 to 90)

func (*Fake) LatitudeDirection 

func (f *Fake) LatitudeDirection() string

LatitudeDirection generates latitude direction (N(orth) o S(outh))

func (*Fake) LatitudeMinutes 

func (f *Fake) LatitudeMinutes() int

LatitudeMinutes generates latitude minutes (from 0 to 60)

func (*Fake) LatitudeSeconds 

func (f *Fake) LatitudeSeconds() int

LatitudeSeconds generates latitude seconds (from 0 to 60)

func (*Fake) Longitude 

func (f *Fake) Longitude() float32

Longitude generates longitude (from -180 to 180)

func (*Fake) LongitudeDegrees 

func (f *Fake) LongitudeDegrees() int

LongitudeDegrees generates longitude degrees (from -180 to 180)

func (*Fake) LongitudeDirection 

func (f *Fake) LongitudeDirection() string

LongitudeDirection generates (W(est) or E(ast))

func (*Fake) LongitudeMinutes 

func (f *Fake) LongitudeMinutes() int

LongitudeMinutes generates (from 0 to 60)

func (*Fake) LongitudeSeconds 

func (f *Fake) LongitudeSeconds() int

LongitudeSeconds generates (from 0 to 60)

func (*Fake) MaleFirstName 

func (f *Fake) MaleFirstName() string

MaleFirstName generates male first name

func (*Fake) MaleFullName 

func (f *Fake) MaleFullName() string

MaleFullName generates male full name it can occasionally include prefix or suffix

func (*Fake) MaleFullNameWithPrefix 

func (f *Fake) MaleFullNameWithPrefix() string

MaleFullNameWithPrefix generates prefixed male full name if prefixes for the given language are available

func (*Fake) MaleFullNameWithSuffix 

func (f *Fake) MaleFullNameWithSuffix() string

MaleFullNameWithSuffix generates suffixed male full name if suffixes for the given language are available

func (*Fake) MaleLastName 

func (f *Fake) MaleLastName() string

MaleLastName generates male last name

func (*Fake) MalePatronymic 

func (f *Fake) MalePatronymic() string

MalePatronymic generates male patronymic

func (*Fake) Model 

func (f *Fake) Model() string

Model generates model name that consists of letters and digits, optionally with a hyphen between them

func (*Fake) Month 

func (f *Fake) Month() string

Month generates month name

func (*Fake) MonthNum 

func (f *Fake) MonthNum() int

MonthNum generates month number (from 1 to 12)

func (*Fake) MonthShort 

func (f *Fake) MonthShort() string

MonthShort generates abbreviated month name

func (*Fake) Paragraph 

func (f *Fake) Paragraph() string

Paragraph generates paragraph

func (*Fake) Paragraphs 

func (f *Fake) Paragraphs() string

Paragraphs generates from 1 to 5 paragraphs

func (*Fake) ParagraphsN 

func (f *Fake) ParagraphsN(n int) string

ParagraphsN generates n paragraphs

func (*Fake) Password 

func (f *Fake) Password(atLeast, atMost int, allowUpper, allowNumeric, allowSpecial bool) string

Password generates password with the length from atLeast to atMost characters, allow* parameters specify whether corresponding symbols can be used

Example: 

f := fake.New()
password := f.Password(8, 16, true, true, true)
// Generates password like "Abc123!@"

func (*Fake) Patronymic 

func (f *Fake) Patronymic() string

Patronymic generates patronymic

func (*Fake) Phone 

func (f *Fake) Phone() string

Phone generates random phone number using one of the formats format specified in phone_format file

func (*Fake) Phonef added in v0.1.11 

func (f *Fake) Phonef(format string) string

Phonef generates random phone number using format like #-###-###-##-##

func (*Fake) Product 

func (f *Fake) Product() string

Product generates product title as brand + product name

func (*Fake) ProductName 

func (f *Fake) ProductName() string

ProductName generates product name

func (*Fake) Seed 

func (f *Fake) Seed(seed int64)

Seed uses the provided seed value to initialize the internal PRNG to a deterministic state.

func (*Fake) Sentence 

func (f *Fake) Sentence() string

Sentence generates random sentence

func (*Fake) Sentences 

func (f *Fake) Sentences() string

Sentences generates from 1 to 5 random sentences

func (*Fake) SentencesN 

func (f *Fake) SentencesN(n int) string

SentencesN generates n random sentences

func (*Fake) SetLang 

func (f *Fake) SetLang(newLang string) error

SetLang sets the language in which the data should be generated returns error if passed language is not available

func (*Fake) SimplePassword 

func (f *Fake) SimplePassword() string

SimplePassword is a wrapper around Password, it generates password with the length from 6 to 12 symbols, with upper characters and numeric symbols allowed

func (*Fake) State 

func (f *Fake) State() string

State generates random state

func (*Fake) StateAbbrev 

func (f *Fake) StateAbbrev() string

StateAbbrev generates random state abbreviation

func (*Fake) Street 

func (f *Fake) Street() string

Street generates random street name

func (*Fake) StreetAddress 

func (f *Fake) StreetAddress() string

StreetAddress generates random street name along with building number

func (*Fake) Title 

func (f *Fake) Title() string

Title generates from 2 to 5 titleized words

func (*Fake) TopLevelDomain 

func (f *Fake) TopLevelDomain() string

TopLevelDomain generates random top level domain

func (*Fake) UseExternalFS added in v0.1.2 

func (f *Fake) UseExternalFS(fs fs.FS)

func (*Fake) UserName 

func (f *Fake) UserName() string

UserName generates user name in one of the following forms first name + last name, letter + last names or concatenation of from 1 to 3 lowercased words

func (*Fake) WeekDay 

func (f *Fake) WeekDay() string

WeekDay generates name ot the week day

func (*Fake) WeekDayShort 

func (f *Fake) WeekDayShort() string

WeekDayShort generates abbreviated name of the week day

func (*Fake) WeekdayNum 

func (f *Fake) WeekdayNum() int

WeekdayNum generates number of the day of the week

func (*Fake) Word 

func (f *Fake) Word() string

Word generates random word

func (*Fake) Words 

func (f *Fake) Words() string

Words generates from 1 to 5 random words

func (*Fake) WordsN 

func (f *Fake) WordsN(n int) string

WordsN generates n random words

func (*Fake) Year 

func (f *Fake) Year(from, to int) int

Year generates year using the given boundaries

func (*Fake) Zip 

func (f *Fake) Zip() string

Zip generates random zip code using one of the formats specifies in zip_format file

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.