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.

There's also this alternative: https://github.com/jaevor/go-nanoid.

Install

Via go get tool

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

Usage

Generate ID

id, err := gonanoid.New()

Generate ID with a custom alphabet and length

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

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 Must(l ...int) string
• func MustGenerate(alphabet string, size int) string
• func New(l ...int) (string, error)

Functions

func Generate

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

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

func Must

func Must(l ...int) string

Must is the same as New but panics on error.

func MustGenerate

func MustGenerate(alphabet string, size int) string

MustGenerate is the same as Generate but panics on error.

func New

func New(l ...int) (string, error)

New generates secure URL-friendly unique ID. Accepts optional parameter - length of the ID to be generated (21 by default).