New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
ts-linked-list
Advanced tools
ts-linked-list - npm Package Compare versions
Comparing version 0.0.6 to 1.0.0
| { | ||
| "name": "ts-linked-list", | ||
| "version": "0.0.6", | ||
| "version": "1.0.0", | ||
| "description": "A doubly linked list written in TypeScript", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
| # ts-linked-list | ||
| Yet another yet another doubly linked list, written in TypeScript. | ||
| Yet another yet another doubly linked list, written in TypeScript. It supports | ||
| iterators using a generator function with `Symbol.iterator`, fast index getter in O(n/2) time, | ||
| reversible `forEach`, `map`, `filter` and `reduce` methods, `insertBefore` and `insertAfter` | ||
| any node and generics for TypeScript users. | ||
@@ -9,6 +12,9 @@ ## Installation | ||
| npm install ts-linked-list | ||
| yarn add ts-linked list | ||
| ``` | ||
| or | ||
| ```html | ||
| <script src="https://unpkg.com/ts-linked-list/dist/index.min.js"></script> | ||
| <script src="https://unpkg.com/ts-linked-list/dist/index.js"></script> | ||
| <!-- or --> | ||
| <script **type="module"** src="https://unpkg.com/ts-linked-list/dist/index.es.js"></script> | ||
| ``` | ||
@@ -23,5 +29,9 @@ | ||
| // Create a list from an array alternatively | ||
| const listFromArray = LinkedList.fromArray([1, 2, 3, 'whatever']); | ||
| // TYPESCRIPT ONLY: ts-linked-list uses generics to type the list data | ||
| const typedList = new LinkedList<number>(1, 2, 3); | ||
| const wildList = new LinkedList<any>(1, 'two', () => 3, [4]); | ||
| // Create a list from any iterable alternatively | ||
| const listFromArray = LinkedList.from([1, 2, 3, 'whatever']); | ||
| // Do something with it | ||
@@ -32,35 +42,68 @@ list.forEach(data => doSomethingUseful(data)); | ||
| ## Documentation | ||
| Detailed documentation is available at https://tuelsch.github.io/ts-linked-list/. | ||
| Detailed documentation and code samples are available at https://tuelsch.github.io/ts-linked-list/. | ||
| This is automatically generated from jsDoc-like comments by TypeDoc, a documentation generator specifically written for TypeScript. | ||
| Quick overview of the methods: | ||
| | LinkedList | | ||
| |------------------| | ||
| | append | | ||
| | concat | | ||
| | filter | | ||
| | find | | ||
| | findIndex | | ||
| | findNode | | ||
| | findNodeIndex | | ||
| | forEach | | ||
| | get | | ||
| | getNode | | ||
| | insertAfter | | ||
| | insertAt | | ||
| | insertBefore | | ||
| | map | | ||
| | pop | | ||
| | prepend | | ||
| | push | | ||
| | reduce | | ||
| | removeAt | | ||
| | removeNode | | ||
| | reverse | | ||
| | shift | | ||
| | slice | | ||
| | toArray | | ||
| | toString | | ||
| | from | | ||
| ## Code quality | ||
| This library was created to explore automated tools related to code quality control, so here's what I've come up with. | ||
| This library was created to explore automated tools related to code quality control. | ||
| ### Dependencies | ||
|  | ||
|  | ||
|  | ||
|  | ||
| [](https://greenkeeper.io/) | ||
| This library does not have any dependencies, so the first badge is easy to keep green. The second will be more useful in the future to check wether the devtools need an update. | ||
| This library does not have any dependencies, so the first badge is easy to keep green. The second will be more useful in the future to check wether the devtools need an update. Greenkeeper will | ||
| create a branch with updated dependencies and run the tests. If successful, the dependencies can | ||
| be updated with one click. Neat. | ||
| ### Vulnerabilities | ||
| [](https://snyk.io/test/github/tuelsch/linked-list?targetFile=package.json) | ||
| [](https://snyk.io/test/github/tuelsch/ts-linked-list?targetFile=package.json) | ||
| As this library does not have any dependencies, there will be no vulnerabilities. However, this may change in the future, so it's good someone keeps an eye on it. | ||
| As this library does not have any dependencies, there will be no dependency vulnerabilities. However, this may change in the future, so it's good someone keeps an eye on it. | ||
| ### Testing | ||
| [](https://travis-ci.com/tuelsch/linked-list) | ||
| [](https://travis-ci.com/tuelsch/ts-linked-list) | ||
| Testing the library is essential today, I used Travis CI to check if the tests run successfully. | ||
| Testing the library is essential. Travis CI is used to run the tests on every new branch/pull request and updates on the master branch. | ||
| ### Test coverage | ||
| [](https://codecov.io/gh/tuelsch/linked-list) | ||
| [](https://codeclimate.com/github/tuelsch/linked-list/test_coverage) | ||
| [](https://codecov.io/gh/tuelsch/ts-linked-list) | ||
| [](https://codeclimate.com/github/tuelsch/ts-linked-list/test_coverage) | ||
| Two separate tools are keeping watch here. Setting up either was easy and their results are matching. I'm not sure what the other benefits/drawbacks are so I'm keeping both around until one or the other proves to be more useful. | ||
| Two separate tools are keeping watch here. Setting up either was easy and their results are matching. | ||
| ### Maintainability | ||
| [](https://codeclimate.com/github/tuelsch/linked-list/maintainability) | ||
| [](https://codeclimate.com/github/tuelsch/ts-linked-list/maintainability) | ||
| Codeclimate helps proofread the source code and gives feedback on what a machine thinks is clean code. It's not quite like your buddy giving advice, but it's free and can help you improve your code towards a generally accepted way of coding. | ||
| Codeclimate helps proofread the source code and gives feedback on what a machine thinks is clean code. It's not quite like a buddy giving advice, but it's free for open-source projects and can help improve code towards a generally accepted standard of coding. |
Fixed alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.2%
107980
- Number of low quality alerts
- decreased by-50%
1
- Number of lines in readme file
- increased by67.19%
107
- Number of medium supply chain risk alerts
- decreased by-100%
0
No dependency changes