Skip to content

Latest commit

 

History

History
214 lines (193 loc) · 3.15 KB

README.md

File metadata and controls

214 lines (193 loc) · 3.15 KB
Raw

Faker

Go library that generates fake data. A Golang port of faker.js.

This is still in active development.

Usage Example:

package main

import (
	"fmt"
	"github.com/Arinzeokeke/faker"
)

 func main() {
     // Get faker instance setting default locale to en (english)
     f, err := faker.New(&faker.Config{DefaultLocale: "en"}, "locale")
     if err != nil {
         fmt.Errorf("Error loading locale, %v", err)
     }

     // print fake first name
     fmt.Println(f.Name().FirstName())

     // print fake job title
     fmt.Println(f.Name().JobTitle())

    //  print fake internet email
    fmt.Println(f.Internet().Email("Arinze", "Okeke", "xmail.com"))

     //change locale(language) to example: german. (de)
     f.Lang("de")

     // print fake German full name
     fmt.Println(f.Name().FullName())

     //change locale(language) back to english
     f.Lang("en")

     // print fake English full name
     fmt.Println(f.Name().FullName())
 }

API

  • Address
    • ZipCode
    • City
    • CityPrefix
    • CitySuffix
    • StreetName
    • StreetAddress
    • StreetSuffix
    • StreetPrefix
    • SecondaryAddress
    • County
    • Country
    • CountryCode
    • State
    • StateAbbr
    • Latitude
    • Longitude
  • Name
    • FirstName
    • LastName
    • FindName
    • JobTitle
    • Prefix
    • Suffix
    • Title
    • JobDescriptor
    • JobArea
    • JobType
  • Commerce
    • Color
    • Department
    • ProductName
    • Price
    • ProductAdjective
    • ProductMaterial
    • Product
  • Company
    • CompanyName
    • CompanySuffix
    • CatchPhrase
    • Bs
    • CatchPhraseAdjective
    • CatchPhraseDescriptor
    • CatchPhraseNoun
    • BsAdjective
    • BsBuzz
    • BsNoun
  • Database
    • Column
    • Type
    • Collation
    • Engine
  • Date
    • Past
    • Future
    • Between
    • Recent
    • Soon
    • Month
    • Weekday
  • Finance (TODO)
    • Account
    • AccountName
    • Mask
    • Amount
    • TransactionType
    • CurrencyCode
    • CurrencyName
    • CurrencySymbol
    • BitcoinAddress
    • EthereumAddress
    • Iban
    • Bic
  • Hacker
    • Abbreviation
    • Adjective
    • Noun
    • Verb
    • Ingverb
    • Phrase
  • Image
    • Image
    • Avatar
    • ImageUrl
    • Abstract
    • Animals
    • Business
    • Cats
    • City
    • Food
    • Nightlife
    • Fashion
    • People
    • Nature
    • Sports
    • Technics
    • Transport
    • DataUri
  • Internet
    • Avatar
    • Email
    • ExampleEmail
    • UserName
    • Protocol
    • Url
    • DomainName
    • DomainSuffix
    • DomainWord
    • Ip
    • Ipv6
    • UserAgent
    • Color
    • Mac
    • Password
  • Lorem
    • Word
    • Words
    • Sentence
    • Slug
    • Sentences
    • Paragraph
    • Paragraphs
    • Text
    • Lines
  • Phone (TODO)
    • PhoneNumber
    • PhoneNumberFormat
    • PhoneFormats
  • Random (TODO)
    • Number
    • ArrayElement
    • ObjectElement
    • Uuid
    • Boolean
    • Word
    • Words
    • Image
    • Locale
    • AlphaNumeric
    • HexaDecimal
  • System (TODO)
    • FileName
    • CommonFileName
    • MimeType
    • CommonFileType
    • CommonFileExt
    • FileType
    • FileExt
    • DirectoryPath
    • FilePath
    • Semver

Road Map

  • Finish API Implementation
  • Compulsory Unique Value Feature Implementation
  • Write tests
  • Better Documentation

Credit

License

  • MIT