nanoid

Documentation

Overview

Package nanoid is a tiny, unique string ID generator

Index

• Constants
• func New(opt ...Option) func(int) (string, error)
• func RandomString(size int, opt ...Option) (string, error)
• type Option
  • func WithAlphabet(alphabet string) Option
  • func WithRandomByteGenerator(generator io.Reader) Option

Constants

const (
	// DefaultAlphabet is the default alphabet for the generator which can be used to generate kernel interface names
	DefaultAlphabet = "!\"#$&'()*+,-.012456789;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
)

Functions

func New

func New(opt ...Option) func(int) (string, error)

New creates a new nanoid generator with specified options

func RandomString

func RandomString(size int, opt ...Option) (string, error)

RandomString generates a random string based on size. Original JavaScript implementation: https://github.com/ai/nanoid/blob/main/README.md

Types

type Option

type Option func(o *generatorOpts)

Option represents options for the string generator

func WithAlphabet

func WithAlphabet(alphabet string) Option

WithAlphabet sets a custom alphabet for the generator

func WithRandomByteGenerator

func WithRandomByteGenerator(generator io.Reader) Option

WithRandomByteGenerator sets a generator for random bytes generation