generator

README

Overview

This is a Go library, which can be used to generate random Finnish names.

The API will allow to generate

• Random Finnish male names
• Random Finnish female names
• Random Finnish last names

Documentation

Index

• type FinnishNameGenerator
  • func NewFinnishNameGenerator() FinnishNameGenerator
• type Gender

Types

type FinnishNameGenerator

type FinnishNameGenerator interface {
	// GenerateFirstName generates a first name based on gender.
	GenerateFirstName(gender Gender) string
	// GenerateFirstNameRandomGender generates a random gender first name.
	GenerateFirstNameRandomGender() string
	// GenerateLastName generates a last name.
	GenerateLastName() string
}

FinnishNameGenerator is an interface for generating random Finnish first names and last names.

func NewFinnishNameGenerator

func NewFinnishNameGenerator() FinnishNameGenerator

NewFinnishNameGenerator returns a new FinnishNameGenerator, or error if failed.

type Gender

type Gender int

const (
	Male Gender = iota
	Female
)