uniquenamegenerator

README

go-unique-name-generator

unique name generator for go with 308,769,760 unique combinations by default

Installation

go get github.com/dillonstreator/go-unique-name-generator

Basic Usage

package main

import (
    "fmt"

    ung "github.com/dillonstreator/go-unique-name-generator"
)

func main() {
    generator := ung.NewUniqueNameGenerator()

    fmt.Println(generator.Generate())
    // "{adjective}_{color}_{name}"

    fmt.Println(generator.UniquenessCount())
    // 308769760
}

Usage continued (examples)

Documentation

Index

• func WithDictionaries(dictionaries [][]string) option
• func WithSanitizer(sanitizer Sanitizer) option
• func WithSeparator(separator string) option
• func WithStyle(style Style) option
• type Sanitizer
• type Style
• type UniqueNameGenerator
  • func NewUniqueNameGenerator(opts ...option) *UniqueNameGenerator
  • func (ung *UniqueNameGenerator) Generate() string
  • func (ung *UniqueNameGenerator) UniquenessCount() uint64

Functions

func WithDictionaries

func WithDictionaries(dictionaries [][]string) option

func WithSanitizer

func WithSanitizer(sanitizer Sanitizer) option

func WithSeparator

func WithSeparator(separator string) option

func WithStyle

func WithStyle(style Style) option

Types

type Sanitizer

type Sanitizer func(str string) string

type Style

type Style int

const (
	Lower Style = iota
	Upper
	Capital
)

type UniqueNameGenerator

type UniqueNameGenerator struct {
	// contains filtered or unexported fields
}

UniqueNameGenerator is a unique name generator instance

func NewUniqueNameGenerator

func NewUniqueNameGenerator(opts ...option) *UniqueNameGenerator

NewUniqueNameGenerator creates a new instance of UniqueNameGenerator

func (*UniqueNameGenerator) Generate

func (ung *UniqueNameGenerator) Generate() string

Generate generates a new unique name with the configuration

func (*UniqueNameGenerator) UniquenessCount

func (ung *UniqueNameGenerator) UniquenessCount() uint64

UniquenessCount returns the number of unique combinations