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(alphabet string, size int) (string, error)
• func Nanoid(param ...int) (string, error)
• type Generator

Functions

func Generate

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

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

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