0.1.6 • Published 4 years ago
yard-ts v0.1.6
yard-ts - Yet Another Repository of Datastructures - Ts
Targets to be a hlighly powerful, low dependency set of datastructures written in TypeScript (The name is such because finding a repo name that doesn't exist already is tougher than it looks)
Table Of Contents
- yard-ts - Yet Another Repository of Datastructures - Ts
- Table Of Contents
- Install
- Usage
- Status
- Contributing
- Testing
- License
Install
For the latest release version
npm i yard-ts
To get the cool stuff right away
npm i yashshah1/yard-ts#master
Usage
CommonJS
- const ds = require('yard-ts');
+ const ds = require('yard-ts').default;
ES
import ds from 'yard-ts';
Browser (18 Kb)
<script src="https://cdn.jsdelivr.net/gh/yashshah1/yard-ts/dist/bundle.min.js">
Status
- Linked List
- Singly Linked List - done
- Doubly Linked List - done
- Stack
- Array Stack - done
- Linked List Stack - done
- Queue
- Array Queue - done
- Linked List Queue - done
- Binary Trees
- Binary Search Tree - done
- AVL Tree - done (tests pending)
- Trie - done (tests pending)
- Graph - in progress
- Heap - done (tests in progress)
- Priority Queue - done (tests pending)
- HashTable - in progress
Contributing
Feel free to fork and raise a PR with any bugfix / contribution. See Status for things that are pending
Naming Convention
- Folders - All lowercased, hypen (
-
) seperated - Code Files -
PascalCased.ts
- Test Files -
PascalCased.test.ts
(Must reside in__tests__
)
Testing
npm test
This should run all the tests, to run a specific test run
npm test -- -t <Keyword identifier>
As of writing, the test suite covers:
98.27%
of statements94.44%
of branches98.25%
of functions99.34%
of lines
License
Code is distributed under MIT License. Full license here
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!