funkyurl

README

funkyurl

Go package for generating funky urls or IDs like Twitch does for clips. short reddit explanation

Example outputs

SureStrongWord
HighFullProgram
ImportantRecentTime
EarlyLargeGroup

Usage

Using base list in files folder

fuo, err := funkyurl.Initialize(nil, nil)
if err != nil {
log.Fatal(err)
}
s := fuo.Generate()

Custom wordlist

adjectives := []string{"foo", "bar"}
nouns := []string{"foo", "bar"}

wordlist := funkyurl.CustomWords{
Adjectives: adjectives,
Nouns: nouns
}

options := funkyurl.FunkyOptions{
DeleteUsed: true
}

foo, err := funkyurl.Initalize(&wordlist, &options)
s := fuo.Generate()

Documentation

Index

• type CustomWords
• type FUObject
  • func Initialize(c *CustomWords, opt *FunkyOptions) (*FUObject, error)
  • func (f *FUObject) Generate() string
• type FunkyOptions

Types

type CustomWords

type CustomWords struct {
	Adjectives []string `json:"adjectives"`
	Nouns      []string `json:"nouns"`
}

type FUObject

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

func Initialize

func Initialize(c *CustomWords, opt *FunkyOptions) (*FUObject, error)

func (*FUObject) Generate

func (f *FUObject) Generate() string

type FunkyOptions

type FunkyOptions struct {
	DeleteUsed bool
}