@jwooky/base62-uuid/README.md

Base62 encoder / decoder and UUID generator (RFC4122)

# @jwooky/base62-uuid

[![test_status](
https://github.com/jwooky/base62-uuid/actions/workflows/build-test.yml/badge.svg)](https://github.com/jwooky/base62-uuid/actions/workflows/build-test.yml/badge.svg)
[![coverage_status](https://codecov.io/gh/jwooky/base62-uuid/branch/master/graph/badge.svg?token=ZIRRO8TIO2)](https://codecov.io/gh/jwooky/base62-uuid)

base62-uuid generates short URL safe identifiers that can be used for encoding / decoding standard UUID strings.

## Getting Started

    npm install @jwooky/base62-uuid

## Example Usage:

    import Base62UUID from '@jwooky/base62-uuid';
    // or for CommonJS
    const Base62UUID = require('@jwooky/base62-uuid')

    const base62 = new Base62UUID()

    // Generate a random Base62 string
    const randB62 = base62.v4()
    console.log(randB62)

    // Generate a random UUID string
    const randUUID = base62.uuid()
    console.log(randUUID)

    // Encode existing UUID to Base62 string
    const uuid = base62.uuid()
    const randUUID = base62.encode(uuid)
    console.log(randUUID)

    // Decode Base62 value to UUID string
    const b62Str = base62.v4()
    const randUUID = base62.decode(b62str)
    console.log(randUUID)


## Running Tests

    npm test 

## Running Example Scripts

The example script `examples/example.ts` provides examples for using each UUID version

  * Generating random Base62 strings 
  * Generating UUID with specific version
  * Encoding UUID to a Base62 string
  * Decoding Base62 string back to UUID

Execute the following comand to

    npm run example