uinames

README

go-uinames

go-uinames is a Go wrapper for https://uinames.com

Getting Started

import "github.com/tobiola/go-uinames"

Example

// Generate a random Name struct
name, _ := uinames.GetName(nil)

// Generate an array of 5 NameExtra structs from the region United States
options := uinames.Options{Region: "United States", Amount: 5}
names, _ := uinames.GetNames(&options)

Documentation

Index

• type Birthday
• type CreditCard
• type Name
  • func GetName(o *Options) (Name, error)
• type NameExtra
  • func GetNameExtra(o *Options) (NameExtra, error)
• type Names
  • func GetNames(o *Options) (Names, error)
• type NamesExtra
  • func GetNamesExtra(o *Options) (NamesExtra, error)
• type Options

Types

type Birthday

type Birthday struct {
	DayMonthYear string `json:"dmy"`
	MonthDayYear string `json:"mdy"`
	Raw          int    `json:"raw"`
}

type CreditCard

type CreditCard struct {
	Expiration string `json:"expiration"`
	Number     string `json:"number"`
	Pin        int    `json:"pin"`
	Security   int    `json:"security"`
}

type Name

type Name struct {
	Name    string `json:"name"`
	Surname string `json:"surname"`
	Gender  string `json:"gender"`
	Region  string `json:"region"`
}

func GetName

func GetName(o *Options) (Name, error)

type NameExtra

type NameExtra struct {
	Name       string     `json:"name"`
	Surname    string     `json:"surname"`
	Gender     string     `json:"gender"`
	Region     string     `json:"region"`
	Age        int        `json:"age"`
	Title      string     `json:"title"`
	Phone      string     `json:"phone"`
	Birthday   Birthday   `json:"birthday"`
	Email      string     `json:"email"`
	Password   string     `json:"password"`
	CreditCard CreditCard `json:"credit_card"`
	Photo      string     `json:"photo"`
}

func GetNameExtra

func GetNameExtra(o *Options) (NameExtra, error)

type Names

type Names []Name

func GetNames

func GetNames(o *Options) (Names, error)

type NamesExtra

type NamesExtra []NameExtra

func GetNamesExtra

func GetNamesExtra(o *Options) (NamesExtra, error)

type Options

type Options struct {
	Amount int    `url:"amount,omitempty"`
	Gender string `url:"gender,omitempty"`
	Region string `url:"region,omitempty"`
	MinLen int    `url:"minlen,omitempty"`
	MaxLen int    `url:"maxlen,omitempty"`
}