names

Documentation

Overview

Package names provides functionality to generate names for humans.

Index

• type Generator
  • func (g Generator) Degree() string
  • func (g Generator) FirstName(gen gender.Internal, year int) string
  • func (g Generator) MiddleName(gen gender.Internal) string
  • func (g Generator) Prefix(gen gender.Internal) string
  • func (g Generator) Suffix() string
  • func (g Generator) Surname() string

Types

type Generator

type Generator struct {
	Data *config.Data
}

Generator is a generator of names.

func (Generator) Degree

func (g Generator) Degree() string

Degree returns a random degree.

func (Generator) FirstName

func (g Generator) FirstName(gen gender.Internal, year int) string

FirstName returns a random first name based on the given gender and the year the person was born.

func (Generator) MiddleName

func (g Generator) MiddleName(gen gender.Internal) string

MiddleName returns a random middle name based on the given gender.

func (Generator) Prefix

func (g Generator) Prefix(gen gender.Internal) string

Prefix returns a random prefix based on the given gender.

func (Generator) Suffix

func (g Generator) Suffix() string

Suffix returns a random suffix.

func (Generator) Surname

func (g Generator) Surname() string

Surname returns a random surname.