gonanoid

README

Go Nanoid

This package is Go implementation of ai's nanoid!

Safe. It uses cryptographically strong random generator.

Compact. It uses more symbols than UUID (A-Za-z0-9_-) and has the same number of unique options in just 22 symbols instead of 36.

Fast. Nanoid is as fast as UUID but can be used in URLs.

Install

Via go get tool

$ go get github.com/matoous/go-nanoid

Usage

Generate ID

id, err := gonanoid.Nanoid()

Generate ID with custom alphabet and length

id, err := gonanoid.Generate("abcde", 54)

Testing

$ go test

Notice

If you use Go Nanoid in your project, please let me know!

If you have any issues, just feel free and open it in this repository, thanks!

Credits

• ai - nanoid
• icza - his tutorial on random strings in Go

License

The MIT License (MIT). Please see License File for more information.

Documentation

Index

• func Generate(rawAlphabet string, size int) (string, error)
• func ID(l int) (string, error)
• func MustGenerate(rawAlphabet string, size int) string
• func MustID(l int) string
• func Nanoid(param ...int) (string, error)
• type Generator

Functions

func Generate

func Generate(rawAlphabet string, size int) (string, error)

Generate is a low-level function to change alphabet and ID size.

func ID

func ID(l int) (string, error)

ID provides more golang idiomatic interface for generating IDs. Calling ID is shorter yet still clear `gonanoid.ID(20)` and it requires the lengths parameter by default.

func MustGenerate

func MustGenerate(rawAlphabet string, size int) string

MustGenerate is the same as Generate but panics on error.

func MustID

func MustID(l int) string

MustID is the same as ID but panics on error.

func Nanoid

func Nanoid(param ...int) (string, error)

Nanoid generates secure URL-friendly unique ID.

Types

type Generator

type Generator func([]byte) (int, error)

Generator function

var BytesGenerator Generator = rand.Read

BytesGenerator is the default bytes generator