# ds-lib

> A JavaScript Data Structure library

Latest version **0.0.5** (published 2017-08-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install ds-lib
pnpm add ds-lib
yarn add ds-lib
bun add ds-lib
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2017-08-20 |
| First published | 2017-08-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Harshit Sinha |
| Maintainers | harshit-sinha-developer |

## Links

- npm: https://www.npmjs.com/package/ds-lib
- Repository: https://github.com/harshit-sinha/js-data_structures
- Homepage: https://github.com/harshit-sinha/js-data_structures#readme
- Issues: https://github.com/harshit-sinha/js-data_structures/issues
- npm.io page: https://npm.io/package/ds-lib

## Recent versions

- 0.0.5 (latest) — 2017-08-20
- 0.0.4 — 2017-08-20
- 0.0.3 — 2017-08-15
- 0.0.2 — 2017-08-15
- 0.0.1 — 2017-08-15
- 1.0.0 — 2017-08-15

## README

# DS-Lib

An implementation of basic Data Structures in JavaScript

## Getting Started

#### In Browser
To use the Library in browser Download the [dist/dslib.min.js](https://github.com/harshit-sinha-developer/DS-Lib/blob/master/dist/dslib.min.js) file and include it into your scripts
```
<script src="dslib.min.js"></script>
```

#### Node.js
1. To use the Library in Node.js install the Library through npm
```
npm install ds-lib --save
```
2. Include the library in your source code
```
var DsLib = require('ds-lib');
```

## API Documentation
For the complete API reference, please [refer](https://github.com/harshit-sinha-developer/DS-Lib/wiki)

## Included Data Structures

### 1. Linked List
```
var linkedList = new DsLib.LinkedList();
linkedList.addItem(1);
linkedList.addItem(2);
linkedList.addItem(3);
linkedList.addItem(4);
linkedList.addItem(5);
linkedList.addItem(6);
linkedList.addItem(7);

linkedList.map(function(value) {
    console.log(value);
});

// Output
// 1
// 2
// 3
// 4
// 5
// 6
// 7

console.log(linkedList.toArray())

// Output
// [1, 2, 3, 4, 5, 6, 7]
```

### 2. Queue
```
var queue = new DsLib.QueueList();
queue.enqueue(1);
queue.enqueue(2);
queue.enqueue(3);
queue.enqueue(4);
queue.enqueue(5);
queue.enqueue(6);

queue.map(function(value) {
    console.log(value)
});
// Output
// 1
// 2
// 3
// 4
// 5
// 6

queue.dequeue();
queue.dequeue();
queue.map(function(value) {
    console.log(value)
});
// Output
// 3
// 4
// 5
// 6
```

### 3. Stack
```
var stack = new DsLib.StackList();
stack.push(1);
stack.push(2);
stack.push(3);
stack.push(4);
stack.push(5);
stack.push(6);

console.log(stack.toArray());
// Output
// [1, 2, 3, 4, 5, 6]

stack.pop();
stack.pop();
// Output
// [1, 2, 3, 4]
console.log(stack.toArray());
```

## Contributing

### Prerequisites
1. **Node.js** - Download it from [here](https://nodejs.org/en/).
2. **Webpack** - npm install webpack -g

### Steps to setup locally
1. git clone https://github.com/harshit-sinha-developer/DS-Lib.git
2. npm install
3. npm start

---
_Source: https://npm.io/package/ds-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._