Introduction

Welcome to TypeScript ADT Library! This library provides implementations of common data structures using TypeScript. An interface-based approach is taken to ensure flexibility and consistency in how you interact with different data structures implementations. Whether working on a backend project with Node.js or a frontend application with React, Angular, or Vue.js, this library is designed to be easy to use and integrate.

Usage

Installation

npm install @dmohindru/typescript-adt

CommonJS

const { ArrayList } = require('@dmohindru/typescript-adt/list');

// Create List
const list = new ArrayList(['one', 'two', 'three']);

// Add Items to list
list.append('four');

// Run operation on each item
list.forEach((item, index) =>
    console.log(`[${index}] - ${item}`));

...

ES Module

import { ArrayList } from '@dmohindru/typescript-adt/list';

// Create List
const list = new ArrayList(['one', 'two', 'three']);

// Add Items to list
list.append('four');

// Run operation on each item
list.forEach((item, index) =>
    console.log(`[${index}] - ${item}`))

...

Typescript Config

For typescript to be able to find type definition files for this library make sure tsconfig.json as following settings

{
  ... other setting
  "module": "NodeNext",
  "moduleResolution": "NodeNext"
}

Interfaces and Implementations

Library is built on a robust set of interfaces to ensure consistency and flexibility. Below are the primary interfaces provided by the library and some of their implementations.

Interfaces

• List<T>: A linear collection that allows for indexed access to elements.
• Stack<T>: A collection that follows the Last-In-First-Out (LIFO) principle.
• Queue<T>: A collection that follows the First-In-First-Out (FIFO) principle.
• Graph<T>: A collection of nodes connected by edges. (TBI)
• Tree<T>: A hierarchical structure of nodes. (TBI)

Implementation

List<T>

• ArrayList

// CommonJS
const { List, ArrayList } = require('@dmohindru/typescript-adt/list');

// ES Module
import { List, ArrayList } from '@dmohindru/typescript-adt/list';

• LinkedList

// CommonJS
const { List, LinkedList } = require('@dmohindru/typescript-adt/list');

// ES Module
import { List, LinkedList } from '@dmohindru/typescript-adt/list';

Stack<T>

• ArrayStack

// CommonJS
const { Stack, ArrayStack } = require('@dmohindru/typescript-adt/stack');

// ES Module
import { Stack, ArrayStack } from '@dmohindru/typescript-adt/stack';

Queue<T>

• ArrayQueue

// CommonJS
const { Queue, ArrayQueue } = require('@dmohindru/typescript-adt/queue');

// ES Module
import { Queue, ArrayQueue } from '@dmohindru/typescript-adt/queue';

Links

• API Docs
• Github