list-toolkit 2.2.6 → 2.3.1

package/README.md

@@ -3,50 +3,31 @@
 [npm-img]: https://img.shields.io/npm/v/list-toolkit.svg
 [npm-url]: https://npmjs.org/package/list-toolkit
 
-List-based **efficient** data structures to organize your objects.
-This is a pure JavaScript module with no dependencies
-suitable to use in all environments including browsers.
+Efficient list-based data structures for JavaScript.
+Pure ESM, zero dependencies, works in Node.js, Bun, Deno, and browsers.
 
-The toolkit provides the following data structures with a full set of efficiently implemented operations:
+Data structures included:
 
-* Converters for `null`-terminated (NT) lists, both singly and doubly linked. They convert in place from NT lists to circular lists and back.
-* Various lists:
-  * Doubly linked circular lists (DLL) and singly linked circular lists (SLL).
-  * Value-based lists, where a list serves as a container for external objects, and node-based lists, where a list uses custom properties on external objects to link them around.
-  * Hosted lists, which use a special head node to manage nodes, and headless lists, which point to an external list without including any headers.
-* Heaps:
-  * Priority queues: min heap, leftist heap, skew heap.
-* Various list-based data structures:
-  * Caches with various eviction algorithms: least recently used (LRU), least frequently used (LFU), first in first out (FIFO), and random.
-    * A decorator is provided to decorate functions, methods, and getters with a cache of your choice.
-  * Queue: an adapter for lists.
-* Numerous list utilities.
+- **Linked lists** — doubly and singly linked, circular. Node-based (link properties on your objects) or value-based (wraps values in nodes). Hosted (sentinel head) or headless (external pointer).
+- **NT list converters** — convert null-terminated lists to/from circular lists in place.
+- **Heaps** — min heap, leftist heap, skew heap.
+- **Caches** — LRU, LFU, FIFO, random eviction. Includes a decorator for functions, methods, and getters.
+- **Queue and Stack** — list-backed adapters.
+- **Splay tree** — self-adjusting binary search tree.
+- **Utilities** — push/append values, find, remove, validate, and more.
 
-All lists can be used without the toolkit. Your existing lists, either doubly or singly linked,
-can be used. The toolkit provides a few utilities that you would write yourself if you wanted to use them.
+Works with your existing linked lists — no wrapper objects required.
 
-The implementation philosophy was very simple:
+- Flexible, efficient, simple.
+- Zero dependencies, no surprises.
+- Pay only for what you use.
+- Usable as a foundation for other data structures.
 
-* Flexibility, efficiency, and simplicity.
-* No dependencies. No unexpected surprises.
-* You never pay for what you don't use.
-* Suitable for all environments.
-* Should be usable with already existing lists.
-* Could be used as a foundation for other list-based data structures.
+**Read all about the implemented ideas in the [Backgrounder](https://github.com/uhop/list-toolkit/wiki/Backgrounder).**
 
-**Read all about the implemented ideas in the [Backgrounders](./Backgrounder).**
+All lists share a consistent API: create from iterables, push/pop, insert/extract/remove, forward and reverse iterators, sort, reverse, and customizable link names.
 
-All lists support similar intuitive interfaces:
-
-* Creating from existing objects.
-* Adding, inserting, extracting and removing nodes.
-* Forward and reverse iterators.
-* General manipulations like reversing and sorting.
-* Link names for the next and previous links (for doubly linked lists) are customizable.
-
-All facilities are efficient, well-debugged, and battle-tested.
-
-**All documentation is in the [wiki](https://github.com/uhop/list-toolkit/wiki).**
+**Full documentation: [wiki](https://github.com/uhop/list-toolkit/wiki).**
 
 ## Installation
 
@@ -56,9 +37,9 @@ npm install list-toolkit
 
 ## Introduction
 
-The full documentation is available in the project's [wiki](https://github.com/uhop/list-toolkit/wiki). Below is a cheat sheet of the API.
+See the [wiki](https://github.com/uhop/list-toolkit/wiki) for full documentation. Quick examples below.
 
-Value lists are containers for arbitrary values:
+Value lists wrap arbitrary values:
 
 ```js
 import ValueList from 'list-toolkit/value-list.js';
@@ -79,7 +60,7 @@ for (const value of list) {
 list.pushBack(4);
 list.pushFront(0);
 
-console.log(list.popFront().value); // 0
+console.log(list.popFront()); // 0
 console.log(list.front.value); // 1
 ```
 
@@ -92,7 +73,7 @@ class Person {
   constructor(name) {
     this.name = name;
   }
-};
+}
 
 const john = new Person('John'),
   jane = new Person('Jane'),
@@ -126,14 +107,14 @@ for (const node of people) {
 }
 
 // let's extract all people from Jill to Jim
-const ji = people.extract({from: jill, to: jim});
+const ji = people.extractRange({from: jill, to: jim});
 for (const node of people) console.log(node.name); // Jane, John
-for (const node of ji) console.log(node.name); // Jim, Jill
+for (const node of ji) console.log(node.name); // Jill, Jim
 
 // add them back:
 people.append(ji);
 for (const node of people.getReverseIterator()) {
-  console.log(node.name); // Jill, Jim, John, Jane
+  console.log(node.name); // Jim, Jill, John, Jane
 }
 ji.isEmpty === true;
 
@@ -146,15 +127,17 @@ BSD 3-Clause "New" or "Revised" License. See the LICENSE file for details.
 
 ## Release History
 
-* 2.2.6 *Updated dev dependencies.*
-* 2.2.5 *Updated dev dependencies.*
-* 2.2.4 *Updated dev dependencies.*
-* 2.2.3 *Updated dev dependencies.*
-* 2.2.2 *Updated dev dependencies.*
-* 2.2.1 *Technical release: updated deps, added more tests.*
-* 2.2.0 *Added leftist and skew heaps.*
-* 2.1.1 *Allowed functions to be used as nodes. Updated deps.*
-* 2.1.0 *Added splay tree. Updated deps.*
-* 2.0.0 *New major release.*
+- 2.3.1 _Bugfixes. Improved TS typing tests. Updated docs. Updated dev dependencies._
+- 2.3.0 _Added TypeScript declarations for all modules. Added JSDoc. Removed CJS build. Bugfixes. Added missing methods._
+- 2.2.6 _Updated dev dependencies._
+- 2.2.5 _Updated dev dependencies._
+- 2.2.4 _Updated dev dependencies._
+- 2.2.3 _Updated dev dependencies._
+- 2.2.2 _Updated dev dependencies._
+- 2.2.1 _Technical release: updated deps, added more tests._
+- 2.2.0 _Added leftist and skew heaps._
+- 2.1.1 _Allowed functions to be used as nodes. Updated deps._
+- 2.1.0 _Added splay tree. Updated deps._
+- 2.0.0 _New major release._
 
 For more info consult full [release notes](https://github.com/uhop/list-toolkit/wiki/Release-notes).