miniid

README

miniid

miniid generates ID encoded in base62.

Features

• Simple API.
• Clean and tested code.
• Dependency-free.

Install

Go version 1.20+

go get github.com/cristalhq/miniid

Example

gen := miniid.New(1200)

for i := 0; i < 10; i++ {
	fmt.Print(gen.Next(), " ")
}
fmt.Println()

// Output:
// JN JO JP JQ JR JS JT JU JV JW

Also see examples: example_test.go.

Documentation

See these docs.

License

MIT License.

Documentation

Overview

Example

package main

import (
	"fmt"

	"github.com/cristalhq/miniid"
)

func main() {
	gen := miniid.New(1200)

	for i := 0; i < 10; i++ {
		fmt.Print(gen.Next(), " ")
	}
	fmt.Println()

}

Output:

JN JO JP JQ JR JS JT JU JV JW

Index

• type Generator
  • func New(initID uint64) *Generator
  • func (g *Generator) Next() string

Examples

• Package

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator can encode integers into base62 strings.

func New

func New(initID uint64) *Generator

NewGenerator creates a new generator using the provided init number.

func (*Generator) Next

func (g *Generator) Next() string

Next returns a next ID in base62.