humanid

README

@42peaks/human-id

Introduction

This package generates short, human-readable IDs of the form: <adjective>-<noun>-<number> where number is a random number between 1 and 999999.

Usage

Quite simple:

import (
    "github.com/42peaks/humanid"
    "fmt"
)

func main() {
	id, err := humanid.Generate()
}

Documentation

Index

• Variables
• func Generate() (string, error)
• type AdjectivesType
  • func (t AdjectivesType) GetRandomWord() (string, error)
  • func (t AdjectivesType) MustGetRandomWord() string
• type NounsType
  • func (t NounsType) GetRandomWord() (string, error)
  • func (t NounsType) MustGetRandomWord() string

Variables

var (
	Adjectives = AdjectivesType{}/* 267 elements not displayed */

)

var (
	Nouns = NounsType{}/* 267 elements not displayed */

)

Functions

func Generate

func Generate() (string, error)

Types

type AdjectivesType

type AdjectivesType []string

func (AdjectivesType) GetRandomWord

func (t AdjectivesType) GetRandomWord() (string, error)

func (AdjectivesType) MustGetRandomWord

func (t AdjectivesType) MustGetRandomWord() string

type NounsType

type NounsType []string

func (NounsType) GetRandomWord

func (t NounsType) GetRandomWord() (string, error)

func (NounsType) MustGetRandomWord

func (t NounsType) MustGetRandomWord() string