sb-js-data-structures

Data Structures

JavaScript Data Structure written in TypeScript

Summary

• Data Structures
  • Summary
  • Installation and Usage
    • Server-side:
      • Typescript
  • Documentation
    • Linked List
      • Initializer
      • Methods
        • addToLast
          • Parameters
          • Description
        • addToHead
          • Parameters
          • Description
        • addElementAtPosition
          • Parameters
          • Description
        • removeFromLast
          • Description
        • removeFromHead
          • Description
        • removeFirstElementFoundFromList
          • Parameters
          • Description
        • removeAllElementsFromList
          • Parameters
          • Description
        • reverse
          • Description
        • fromArray
          • Parameters
          • Description
        • toArray
          • Description
        • getLength
          • Description
        • isEmpty
          • Returns
          • Description
        • print
          • Description
  • License

Installation and Usage

Server-side:

Using npm:

npm install sb-ds-data-structures

Then where needed:

Typescript

import { LinkedList } from 'sb-js-data-structures'

const list = new LinkedList()

list.addToLast(1)
list.addToLast(2)

Documentation

Linked List

Creates a Linked List, a data structure where each element is a separate object and the elements are linked using pointers.

Initializer

import { LinkedList } from 'sb-js-data-structures'

const list = new LinkedList()

Methods

addToLast

public addToLast(element: T): void

Parameters

• element T - The element to be inserted

Description

Insert an element to the ending of the Linked List.

addToHead

public addToHead(element: T): void

Parameters

• element T - The element to be inserted

Description

Insert an element to the beginning of the Linked List.

addElementAtPosition

public addElementAtPosition(element: T, position: number): void

Parameters

• element T - The element to be inserted
• position number - position where the element should be inserted

Description

Insert an element to a specific position of the Linked List, since position is less then the number of elements of the Linked List.

removeFromLast

public removeFromLast(): void

Description

Remove the element on the ending of the Linked List.

removeFromHead

public removeFromHead(): void

Description

Remove the element on the beginning of the Linked List.

removeFirstElementFoundFromList

public removeFirstElementFoundFromList(element: T): void

Parameters

• element T - The element to be removed

Description

Remove the first element found on the Linked List.

removeAllElementsFromList

public removeAllElementsFromList(element: T): void

Parameters

• element T - The element to be removed

Description

Remove all the elements found on the Linked List.

reverse

public reverse(): void

Description

Reverse the Linked List.

fromArray

public fromArray(element: T[]): void

Parameters

• elements T[] - Array of elements

Description

Insert all the elements at the ending of the Linked List.

toArray

public toArray(): T[]

Description

Create an array with all the elements of the Linked List.

getLength

public getLength(): number

Description

Get the length of the Linked List.

isEmpty

public isEmpty(): boolean

Returns

• boolean - Returns true if the Linked List has no elements, otherwise, returns false.

Description

Informs if the Linked List is empty.

print

public isEmpty(): boolean

Description

Console log the Linked List elements.

License

MIT