Utilities

This utilities functions aims to share and re-use useful typed utilities functions I came accross.

Disclaimer

This is a work in progress tool and mainly aimed at my personal use accross my projects.

Installation

npm install @nicolastoulemont/utilities
or
yarn add @nicolastoulemont/utilities

Functions

Colors

• randomHex()

function randomHex(): string;

• isHex()

function isHex(hex: string): boolean;

• isRgb()

function isRgb({ r: number, g: number, b: number }): boolean;

• hexToRgb()

function hexToRgb(hex: string): { r: number; g: number; b: number };

• rgbToHex()

function rgbToHex({ r: number, g: number, b: number }): string;

• colorBasedOnBg()

function colorBasedOnBg(
  bgHex: string,
  lightColor: string,
  darkColor: string
): string;

Arrays

• flatten()

function flatten<T>(deepArray: Array<T>): Array<T>;

• arrayToRecord()

function arrayToRecord<T extends { [key: string]: any }>(
  array: Array<T>,
  key: string
): Record<string, T>;

Other Data structures

• Stack

const stack = new Stack<T>()
stack.push(value: T): void
stack.pop(): T
stack.peek(): T
stack.clear(): void
stack.print(): void
stack.isEmpty(): boolean
stack.reverse(stack: Stack<T>): void
stack.sort(stack: Stack<T>): void

• Queue

const queue = new Queue<T>()
queue.enqueue(value: T): void
queue.dequeue(): T | null
queue.peek(): T | null
queue.clear(): void
queue.print(): void
queue.reverse(queue: Queue<T>): Queue<T>

• PriorityQueue

const pq = new PriorityQueue<T>()
pq.enqueue(value: T): void
pq.dequeue(): T | null
pq.peek(): T | null
pq.clear(): void
pq.print(): void
pq.reverse(queue: Queue<T>): Queue<T>

• LinkedList

const list = new LinkedList<T>()
list.insertFirst(data: T)
list.insertLast(data: T)
list.insertAt(data: T, index: number)
list.getAt(index: number): T | null
list.removeAt(index: number)
list.clearList()
list.getListAsArray(): Array<T>
list.printList()

• HashTable

const hashTable = new HashTable<T>(size:number)
hashTable.insert(key:string, value: T)
hashTable.get(key:string) T | null
hashTable.remove(key:string)

• Binary Search Tree

const bst = new BST<T>()
bst.add(value: T): void
bst.getMin(): T | null
bst.getMax(): T | null
bst.find(value: T): Node<T> | null
bst.contains(): boolean
bst.remove(value: T): Node<T> | "Tree is empty" | null

Misc

• randomString()

function randomString(): string;

Built with

• tsdx

Versionning

This tool use SemVer for versioning.

Licence

MIT