faker

package module
v0.0.0-...-197b789 Latest Latest
Warning

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

 Go to latest Published: Dec 10, 2016 License: MIT Imports: 13 Imported by: 0

README

Faker Package for Go Language

GoDoc

another go faker data generator, with some features

This package and its definitions is inspired by faker.js

Readme, license and complete documentation will updated soon.

Thanks

Documentation

Overview

Package faker is just another random data generator for go based on faker.js.

To generate random data for testing usually hard. With faker it's easy to create random data that...

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Boolean 

func Boolean() bool

Boolean generate between truthy or falsy.

func GetStaticSeed 

func GetStaticSeed() int64

func Parse 

func Parse(s string) (result string, err error)

func ResetStaticSeed 

func ResetStaticSeed()

func SetLocale 

func SetLocale(l string) error

SetLocale Set data to specific locale.

func Slugify 

func Slugify(s string) string

func StaticSeed 

func StaticSeed(s int64)

func ToJSON 

func ToJSON(data interface{}) (s string, err error)

ToJSON convert data to JSON format.

func ToXML 

func ToXML(data interface{}) (s string, err error)

ToXML convert data to XML format.

func UUID 

func UUID() string

UUID generate random uuid.

Types

type Address 

type Address struct {
	ZipCode     string `json:"zip_code"`
	City        City   `json:"city"`
	Street      Street `json:"street"`
	Secondary   string `json:"secondary_address"`
	County      string `json:"county"`
	Country     string `json:"country"`
	CountryCode string `json:"country_code"`
	State       string `json:"state"`
	StateAbbr   string `json:"state_abbr"`
	Geo         Geo    `json:"geo"`
}

Address is complete type of address. For example user needs random Address data.

func (*Address) BuildingNumberʹ 

func (addr *Address) BuildingNumberʹ() string

BuildingNumberʹ generate building number based on template in locale data.

func (*Address) CityPrefixʹ 

func (addr *Address) CityPrefixʹ() string

CityPrefixʹ generate prefix for City.

func (*Address) CitySuffixʹ 

func (addr *Address) CitySuffixʹ() string

CitySuffixʹ generate suffix for City.

func (*Address) Cityʹ 

func (addr *Address) Cityʹ(params ...interface{}) string

Cityʹ generate random city from data for Address field.

func (*Address) CountryCodeʹ 

func (addr *Address) CountryCodeʹ() string

CountryCodeʹ generate country code from locale data.

func (*Address) Countryʹ 

func (addr *Address) Countryʹ() string

Countryʹ generate country from locale data.

func (*Address) Countyʹ 

func (addr *Address) Countyʹ() string

Countyʹ generate county from locale date.

func (*Address) Fake 

func (addr *Address) Fake()

Fake fill the address field with random data.

func (*Address) Latitudeʹ 

func (addr *Address) Latitudeʹ() string

Latitudeʹ generate random latitude position to Geo.

func (*Address) Longitudeʹ 

func (addr *Address) Longitudeʹ() string

Longitudeʹ generate random longitude position to Geo.

func (*Address) SecondaryAddressʹ 

func (addr *Address) SecondaryAddressʹ() string

SecondaryAddressʹ generate a secondary address template from locale data.

func (*Address) StateAbbrʹ 

func (addr *Address) StateAbbrʹ() string

StateAbbrʹ generate random abbr of state from locale data.

func (*Address) Stateʹ 

func (addr *Address) Stateʹ() string

Stateʹ generate random state from locale data.

func (*Address) StreetAddressʹ 

func (addr *Address) StreetAddressʹ(params ...interface{}) string

StreetAddressʹ generate a street address from locale data.

func (*Address) StreetNameʹ 

func (addr *Address) StreetNameʹ() string

StreetNameʹ generate random street name for Address, based on first name and last name from Name type.

func (*Address) StreetPrefixʹ 

func (addr *Address) StreetPrefixʹ() string

StreetPrefixʹ generate a street prefix from locale data.

func (*Address) StreetSuffixʹ 

func (addr *Address) StreetSuffixʹ() string

StreetSuffixʹ generate a street prefix from locale data.

func (*Address) ToJSON 

func (addr *Address) ToJSON() (s string, err error)

ToJSON encodes Address to JSON format.

func (*Address) ToXML 

func (addr *Address) ToXML() (s string, err error)

ToXML encodes Address to XML format.

func (*Address) ZipCodeʹ 

func (addr *Address) ZipCodeʹ(params ...interface{}) string

ZipCodeʹ generate zip code for Address.

type BusinessSlogan 

type BusinessSlogan struct {
	Adjective string
	Buzz      string
	Noun      string
}

type Card 

type Card struct {
	Name     string
	Username string
	Email    string
	Address  struct {
		StreetA string
		StreetB string
		StreetC string
		StreetD string
		City    string
		State   string
		Country string
		ZipCode string
		Geo     Geo
	}
	Phone          string
	Website        string
	Company        CompanyCard
	Posts          []Post
	AccountHistory []Transaction
}

Card is a normal card with complete data. It provides address, company, post.

func CreateCard 

func CreateCard() (card Card)

CreateCard create a new card and generate its data with random data.

func (*Card) ToJSON 

func (c *Card) ToJSON() (s string, err error)

ToJSON convert card data to JSON format.

type CatchPhrase 

type CatchPhrase struct {
	Adjective  string
	Descriptor string
	Noun       string
}

type City 

type City struct {
	Prefix string `json:"prefix"`
	Suffix string `json:"suffix"`
}

City contains two field, prefix and suffix.

type Commerce 

type Commerce struct {
	Color       string      `json:"color"`
	Department  string      `json:"color"`
	Price       string      `json:"color"`
	ProductName ProductName `json:"product_name"`
}

func (*Commerce) Colorʹ 

func (commerce *Commerce) Colorʹ() string

func (*Commerce) Departmentʹ 

func (commerce *Commerce) Departmentʹ() string

func (*Commerce) Fake 

func (commerce *Commerce) Fake()

Fake Generate random data for all field

func (*Commerce) Priceʹ 

func (commerce *Commerce) Priceʹ(params ...interface{}) string

func (*Commerce) ProductAdjectiveʹ 

func (commerce *Commerce) ProductAdjectiveʹ() string

func (*Commerce) ProductMaterialʹ 

func (commerce *Commerce) ProductMaterialʹ() string

func (*Commerce) ProductNameʹ 

func (commerce *Commerce) ProductNameʹ() string

func (*Commerce) Productʹ 

func (commerce *Commerce) Productʹ() string

func (*Commerce) ToJSON 

func (commerce *Commerce) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Commerce) ToXML 

func (commerce *Commerce) ToXML() (string, error)

ToXML Encode name and its fields to XML.

type Company 

type Company struct {
	Name           string
	Suffix         string
	CatchPhrase    CatchPhrase
	BusinessSlogan BusinessSlogan
}

func (*Company) BSʹ 

func (company *Company) BSʹ() string

func (*Company) BsAdjectiveʹ 

func (company *Company) BsAdjectiveʹ() string

func (*Company) BsBuzzʹ 

func (company *Company) BsBuzzʹ() string

func (*Company) BsNounʹ 

func (company *Company) BsNounʹ() string

func (*Company) CatchPhraseAdjectiveʹ 

func (company *Company) CatchPhraseAdjectiveʹ() string

func (*Company) CatchPhraseDescriptorʹ 

func (company *Company) CatchPhraseDescriptorʹ() string

func (*Company) CatchPhraseNounʹ 

func (company *Company) CatchPhraseNounʹ() string

func (*Company) CatchPhraseʹ 

func (company *Company) CatchPhraseʹ() string

func (*Company) CompanyNameʹ 

func (company *Company) CompanyNameʹ(params ...interface{}) string

func (*Company) CompanySuffixʹ 

func (company *Company) CompanySuffixʹ() string

func (*Company) Fake 

func (company *Company) Fake()

Fake Generate random data for all field

func (*Company) Suffixesʹ 

func (company *Company) Suffixesʹ() []string

func (*Company) ToJSON 

func (company *Company) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Company) ToXML 

func (company *Company) ToXML() (string, error)

ToXML Encode name and its fields to XML.

type CompanyCard 

type CompanyCard struct {
	Name        string
	CatchPhrase string
	Bs          string
}

CompanyCard describes company, its catch phrase and slogan.

type ContextualCard 

type ContextualCard struct {
	Name        string
	Username    string
	Avatar      string
	Email       string
	DateOfBirth string
	Phone       string
	Address     struct {
		Street  string
		Suite   string
		City    string
		ZipCode string
		Geo     Geo
	}
	Website string
	Company CompanyCard
}

ContextualCard is a contextual card. Provide address, and company.

func CreateContextualCard 

func CreateContextualCard() (card ContextualCard)

CreateContextualCard create a new contextual card and generate its data.

func (*ContextualCard) ToJSON 

func (c *ContextualCard) ToJSON() (s string, err error)

ToJSON convert contextual card data to JSON format.

type Date 

type Date struct {
	time.Time
}

func (*Date) Betweenʹ 

func (d *Date) Betweenʹ(from, to string, params ...interface{}) time.Time

func (*Date) Futureʹ 

func (d *Date) Futureʹ(params ...interface{}) time.Time

func (*Date) Monthʹ 

func (d *Date) Monthʹ(options ...interface{}) string

func (*Date) Pastʹ 

func (d *Date) Pastʹ(params ...interface{}) time.Time

Past_ Generate past date It takes two argument yearsAgo and ref date

func (*Date) Recentʹ 

func (d *Date) Recentʹ(params ...interface{}) time.Time

func (*Date) ToJSON 

func (d *Date) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Date) ToXML 

func (d *Date) ToXML() (string, error)

ToXML Encode name and its fields to XML.

func (*Date) Weekdayʹ 

func (d *Date) Weekdayʹ(options ...interface{}) string

type Faker 

type Faker struct {
	Name     Name
	Address  Address
	Commerce Commerce
	Company  Company
	Date     Date
	Finance  Finance
	Hacker   Hacker
	Image    Image
	Internet Internet
	Lorem    Lorem
	Phone    Phone
	// contains filtered or unexported fields
}

Faker is complete structure for all type.

func New 

func New() (f Faker)

New Create new Faker

func (*Faker) Fake 

func (f *Faker) Fake()

Fake Generate random data, fake it all.

type Finance 

type Finance struct {
	Account         FinanceAccount
	Amount          string
	TransactionType string
	Currency        FinanceCurrency
}

Finance

func (*Finance) AccountNameʹ 

func (f *Finance) AccountNameʹ() string

func (*Finance) Accountʹ 

func (f *Finance) Accountʹ(args ...interface{}) int

func (*Finance) Amountʹ 

func (f *Finance) Amountʹ(params ...interface{}) string

func (*Finance) CurrencyCodeʹ 

func (f *Finance) CurrencyCodeʹ() string

func (*Finance) CurrencyNameʹ 

func (f *Finance) CurrencyNameʹ() string

func (*Finance) CurrencySymbolʹ 

func (f *Finance) CurrencySymbolʹ() string

func (*Finance) Fake 

func (f *Finance) Fake()

Fake Generate random data for all field

func (*Finance) Maskʹ 

func (f *Finance) Maskʹ(params ...interface{}) string

func (*Finance) ToJSON 

func (f *Finance) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Finance) ToXML 

func (f *Finance) ToXML() (string, error)

ToXML Encode name and its fields to XML.

func (*Finance) TransactionTypeʹ 

func (f *Finance) TransactionTypeʹ() string

type FinanceAccount 

type FinanceAccount struct {
	Number int
	Name   string
}

func (*FinanceAccount) Nameʹ 

func (fa *FinanceAccount) Nameʹ() string

func (*FinanceAccount) Numberʹ 

func (fa *FinanceAccount) Numberʹ(args ...interface{}) int

type FinanceCurrency 

type FinanceCurrency struct {
	Code   string
	Name   string
	Symbol string
}

Currency

func (*FinanceCurrency) Codeʹ 

func (fc *FinanceCurrency) Codeʹ() string

func (*FinanceCurrency) Nameʹ 

func (fc *FinanceCurrency) Nameʹ() string

func (*FinanceCurrency) Symbolʹ 

func (fc *FinanceCurrency) Symbolʹ() string

type Gender 

type Gender int
const (
	Male Gender = iota
	Female
)

type Geo 

type Geo struct {
	Latitude  string `json:"latitude"`
	Longitude string `json:"longitude"`
}

Geo is geolocation data. It contains latitude and longitude

type Hacker 

type Hacker struct {
	Abbreviation string
	Adjective    string
	Noun         string
	Verb         string
	IngVerb      string
	Phrase       string
}

func (*Hacker) Abbreviationʹ 

func (h *Hacker) Abbreviationʹ() string

func (*Hacker) Adjectiveʹ 

func (h *Hacker) Adjectiveʹ() string

func (*Hacker) Fake 

func (h *Hacker) Fake()

Fake Generate random data for all field

func (*Hacker) IngVerbʹ 

func (h *Hacker) IngVerbʹ() string

func (*Hacker) Nounʹ 

func (h *Hacker) Nounʹ() string

func (*Hacker) Phraseʹ 

func (h *Hacker) Phraseʹ() string

func (*Hacker) ToJSON 

func (h *Hacker) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Hacker) ToXML 

func (h *Hacker) ToXML() (string, error)

ToXML Encode name and its fields to XML.

func (*Hacker) Verbʹ 

func (h *Hacker) Verbʹ() string

type Image 

type Image struct {
	Category string
	Width    int
	Height   int
	Url      string
}

func (*Image) Abstractʹ 

func (image *Image) Abstractʹ(params ...interface{}) string

func (*Image) Animalsʹ 

func (image *Image) Animalsʹ(params ...interface{}) string

func (*Image) Avatarʹ 

func (image *Image) Avatarʹ(params ...interface{}) string

func (*Image) Businessʹ 

func (image *Image) Businessʹ(params ...interface{}) string

func (*Image) Catsʹ 

func (image *Image) Catsʹ(params ...interface{}) string

func (*Image) Cityʹ 

func (image *Image) Cityʹ(params ...interface{}) string

func (*Image) Fake 

func (image *Image) Fake()

Fake Generate random data for all field

func (*Image) Fashionʹ 

func (image *Image) Fashionʹ(params ...interface{}) string

func (*Image) Foodʹ 

func (image *Image) Foodʹ(params ...interface{}) string

func (*Image) Imageʹ 

func (image *Image) Imageʹ(params ...interface{}) string

func (*Image) Natureʹ 

func (image *Image) Natureʹ(params ...interface{}) string

func (*Image) Nightlifeʹ 

func (image *Image) Nightlifeʹ(params ...interface{}) string

func (*Image) Peopleʹ 

func (image *Image) Peopleʹ(params ...interface{}) string

func (*Image) Sportsʹ 

func (image *Image) Sportsʹ(params ...interface{}) string

func (*Image) Technicsʹ 

func (image *Image) Technicsʹ(params ...interface{}) string

func (*Image) ToJSON 

func (image *Image) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Image) ToXML 

func (image *Image) ToXML() (string, error)

ToXML Encode name and its fields to XML.

func (*Image) Transportʹ 

func (image *Image) Transportʹ(params ...interface{}) string

type Internet 

type Internet struct {
	Avatar, Email, Username,
	Protocol, URL, IP, UserAgent, Color, Mac,
	Password string
	Domain InternetDomain
}

func (*Internet) Avatarʹ 

func (i *Internet) Avatarʹ() string

func (*Internet) Colorʹ 

func (i *Internet) Colorʹ(params ...interface{}) string

func (*Internet) DomainNameʹ 

func (i *Internet) DomainNameʹ() string

func (*Internet) DomainSuffixʹ 

func (i *Internet) DomainSuffixʹ() string

func (*Internet) DomainWordʹ 

func (i *Internet) DomainWordʹ() string

func (*Internet) Emailʹ 

func (i *Internet) Emailʹ(params ...interface{}) string

func (*Internet) ExampleEmail 

func (i *Internet) ExampleEmail(params ...interface{}) string

func (*Internet) Fake 

func (i *Internet) Fake()

Fake Generate random data for all field

func (*Internet) IPʹ 

func (i *Internet) IPʹ() string

func (*Internet) Macʹ 

func (i *Internet) Macʹ() string

func (*Internet) Passwordʹ 

func (i *Internet) Passwordʹ() string

TODO: password

func (*Internet) Protocolʹ 

func (i *Internet) Protocolʹ() string

func (*Internet) ToJSON 

func (i *Internet) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Internet) ToXML 

func (i *Internet) ToXML() (string, error)

ToXML Encode name and its fields to XML.

func (*Internet) URLʹ 

func (i *Internet) URLʹ() string

func (*Internet) UserAgentʹ 

func (i *Internet) UserAgentʹ() string

func (*Internet) Usernameʹ 

func (i *Internet) Usernameʹ(params ...interface{}) string

type InternetDomain 

type InternetDomain struct {
	Name   string
	Suffix string
	Word   string
}

func (*InternetDomain) Nameʹ 

func (id *InternetDomain) Nameʹ(params ...interface{}) string

func (*InternetDomain) Suffixʹ 

func (id *InternetDomain) Suffixʹ(params ...interface{}) string

func (*InternetDomain) Wordʹ 

func (id *InternetDomain) Wordʹ(params ...interface{}) string

type Job 

type Job struct {
	Descriptor string `json:"descriptor"`
	Area       string `json:"area"`
	Type       string `json:"type"`
}

Job

type Lorem 

type Lorem struct {
	Word       string
	Words      []string
	Sentence   string
	Sentences  string
	Paragraph  string
	Paragraphs string
}

func (*Lorem) Fake 

func (l *Lorem) Fake()

Fake Generate random data for all field

func (*Lorem) Paragraphsʹ 

func (l *Lorem) Paragraphsʹ(params ...interface{}) string

func (*Lorem) Paragraphʹ 

func (l *Lorem) Paragraphʹ(params ...interface{}) string

func (*Lorem) Sentencesʹ 

func (l *Lorem) Sentencesʹ(params ...interface{}) string

func (*Lorem) Sentenceʹ 

func (l *Lorem) Sentenceʹ(params ...interface{}) string

func (*Lorem) Text 

func (l *Lorem) Text(params ...interface{}) (val string)

func (*Lorem) ToJSON 

func (l *Lorem) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Lorem) ToXML 

func (l *Lorem) ToXML() (string, error)

ToXML Encode name and its fields to XML.

func (*Lorem) Wordsʹ 

func (l *Lorem) Wordsʹ(params ...interface{}) []string

func (*Lorem) Wordʹ 

func (l *Lorem) Wordʹ() string

type Name 

type Name struct {
	FirstName string `json:"first_name"`
	LastName  string `json:"last_name"`
	Title     string `json:"title"`
	Prefix    string `json:"prefix"`
	Suffix    string `json:"suffix"`
	Job       Job    `json:"job"`
}

Name

func (*Name) Fake 

func (name *Name) Fake()

Fake Generate random data for all field

func (*Name) FindNameʹ 

func (name *Name) FindNameʹ(params ...interface{}) string

FindNameʹ Generate first name and last name.

func (*Name) FirstNameʹ 

func (name *Name) FirstNameʹ(params ...interface{}) string

FirstNameʹ Generate first name.

func (*Name) JobAreaʹ 

func (name *Name) JobAreaʹ() string

JobAreaʹ Generate job area.

func (*Name) JobDescriptorʹ 

func (name *Name) JobDescriptorʹ() string

JobDescriptorʹ Generate job descriptor

func (*Name) JobTitleʹ 

func (name *Name) JobTitleʹ() string

JobTitleʹ Generate job title.

func (*Name) JobTypeʹ 

func (name *Name) JobTypeʹ() string

JobTypeʹ Generate job type.

func (*Name) LastNameʹ 

func (name *Name) LastNameʹ(params ...interface{}) string

LastNameʹ Generate last name.

func (*Name) Prefixʹ 

func (name *Name) Prefixʹ(params ...interface{}) string

Prefixʹ Generate prefix name.

func (*Name) Suffixʹ 

func (name *Name) Suffixʹ() string

Suffixʹ Generate suffix name.

func (*Name) Titleʹ 

func (name *Name) Titleʹ() string

Titleʹ Generate title name.

func (*Name) ToJSON 

func (name *Name) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Name) ToXML 

func (name *Name) ToXML() (string, error)

ToXML Encode name and its fields to XML.

type Phone 

type Phone struct {
	Number string
	Format string
}

func (*Phone) Fake 

func (phone *Phone) Fake()

Fake Generate random data for all field

func (*Phone) Formatʹ 

func (phone *Phone) Formatʹ() string

func (*Phone) Numberʹ 

func (phone *Phone) Numberʹ(params ...interface{}) string

func (*Phone) ToJSON 

func (phone *Phone) ToJSON() (string, error)

ToJSON Encode name and its fields to JSON.

func (*Phone) ToXML 

func (phone *Phone) ToXML() (string, error)

ToXML Encode name and its fields to XML.

type Post 

type Post struct {
	Words     []string
	Sentence  string
	Sentences string
	Paragraph string
}

Post is blog post-like

func CreatePost 

func CreatePost() (post Post)

CreatePost generate new post data

type ProductName 

type ProductName struct {
	Product   string `json:"product"`
	Adjective string `json:"adjective"`
	Material  string `json:"material"`
}

type Street 

type Street struct {
	Name    string `json:"name"`
	Address string `json:"address"`
	Prefix  string `json:"prefix"`
	Suffix  string `json:"suffix"`
}

Street is a street address.

type Transaction 

type Transaction struct {
	Amount   string
	Date     string
	Business string
	Name     string
	Type     string
	Account  int
}

Transaction provides financial transaction structure.

func CreateTransaction 

func CreateTransaction() (transaction Transaction)

CreateTransaction create a new transaction card and generate its data.

func (*Transaction) ToJSON 

func (c *Transaction) ToJSON() (s string, err error)

ToJSON convert transaction data to JSON format.

type UserCard 

type UserCard struct {
	Name     string
	Username string
	Email    string
	Address  struct {
		Street  string
		Suite   string
		City    string
		ZipCode string
		Geo     Geo
	}
	Phone   string
	Website string
	Company CompanyCard
}

UserCard describes user card, with address and company.

func CreateUserCard 

func CreateUserCard() (card UserCard)

CreateUserCard create a new user card and generate its data.

func (*UserCard) ToJSON 

func (c *UserCard) ToJSON() (s string, err error)

ToJSON convert user card data to JSON format.

Source Files

View all Source files

Directories

Path Synopsis
en
en/address
en/commerce
en/company
en/date
en/finance
en/hacker
en/internet
en/lorem
en/name
en/phone

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.