README.md

@binary-id

The system uses a combination of binary, bytes and hexadecimals to generate the sequence that gives the base. using RegEx to define patterns when generating the UUID and Token.

Installing

npm i binary-id

# If you're using NPM:
# npm install binary-id

Basic Usage

Just call one of the {Token, UIID} functions after importing them:

import {binary} from 'binary-id'

console.log(binary.Token()) // Xpyci2fycXsbfNhVvSY9IwLejSuKqQZpbt1b 
console.log(binary.UUID()) // 008a0326-b64f-427a-a654-82628fc3e033
 

const {binary} = require("binary-id")

console.log(binary.Token()) // Xpyci2fycXsbfNhVvSY9IwLejSuKqQZpbt1b
console.log(binary.UUID()) // 008a0326-b64f-427a-a654-82628fc3e033
 

API

binary-id

Token — With each call, the function returns a Token. which follows the Token standard.

UUID — With each call, the function returns an UUID that follows the uuid pattern.

export function Token(){
  const set: Set<string> = new Set();
  const token = IsToken({set}) 
  return token; // Xpyci2fycXsbfNhVvSY9IwLejSuKqQZpbt1b
}

export function UUID(): string {
  const set: Set<string> = new Set();
  const id  = IsId({set})
  return id; // 008a0326-b64f-427a-a654-82628fc3e033
}

IsValid — The IsValid function receives the Id as its first parameter and the Token as its optional second parameter. The function returns a boolean (true or false) to indicate whether it is following the pattern established in the RegEx.

export function IsValid(params: string, value?:string): boolean {
  if (value) {
    return (regex.v4.test(params) || regex.v5.test(params)) && regex.token.test(value);
  } else {
    return regex.v4.test(params) || regex.v5.test(params) || regex.token.test(params);
  }
}

import {binary} from 'binary-id'

const uuid = binary.UUID();
binary.IsValid(uuid); //true

const token = binary.Token();
binary.IsValid(token); //true

binary.IsValid(uuid, token); // true

Authors and License

kovarike and project.

MIT License, see the included MIT file.