@joookiwi/collection NPM

Collection (javascript version)

Table of content

The way to think about this is to have the functionalities of other languages (like Java, PHP, C#, Kotlin and even Javascript) all in one standalone structure.

But, with a possible functional approach using the collections.

The structure is and will be in continuous change to implement almost everything that the other languages have (if it is possible).

Installation

npm install @joookiwi/collection
npm i @joookiwi/collection

npm install --save @joookiwi/collection
npm i -S @joookiwi/collection

npm install --save-dev @joookiwi/collection
npm i -D @joookiwi/collection

Usage

There are 3 different kinds of collections (which are all non-mutable).

a minimalist (GenericMinimalistCollectionHolder),
a lazy (LazyGenericCollectionHolder)
and an eager (GenericCollectionHolder) one.

So, no computation can be done "normally" in these instances.

But they can always be converted to the Array, Set, WeakSet (it the type is a WeakKey) or even Map depending on the usage.

It can be separated in different categories. 1. The size methods 2. The research methods 3. The index methods 4. The validation methods 5. The transformation methods 6. The loop methods 7. The reordering methods 8. The conversion methods 9. Some utility methods (not part of the CollectionHolder)

The size methods

Those methods are associated with a size or directly compared

size|length|count
isEmpty
isNotEmpty

The research methods

Those methods are meant to find an element comparing it or giving a value from the collection

get value
- get|at|elementAt
- getFirst|first|firstIndexed
- getLast|last|lastIndexed
get value or else
- getOrElse|atOrElse|elementAtOrElse
get value or null
- getOrNull|atOrNull|elementAtOrNull
- getFirstOrNull|firstOrNull|firstIndexedOrNull
- getLastOrNull|lastOrNull|lastIndexedOrNull
find first value
- findFirst|find|first
- findFirstOrNull|findOrNull|firstOrNull
- findFirstIndexed|findIndexed|firstIndexed
- findFirstIndexedOrNull|findIndexedOrNull|firstIndexedOrNull
find last value
- findLast|last
- findLastOrNull|lastOrNull
- findLastIndexed|lastIndexed
- findLastIndexedOrNull|lastIndexedOrNull

The index methods

Those methods are giving or finding index values in the collection

get index
- firstIndexOf|indexOf
- firstIndexOfOrNull|indexOfOrNull
- lastIndexOf
- lastIndexOfOrNull
find first index
- indexOfFirst|findFirstIndex|findIndex
- indexOfFirstOrNull|findFirstIndexOrNull|findIndexOrNull
- indexOfFirstIndexed|findFirstIndexIndexed|findIndexIndexed
- indexOfFirstIndexedOrNull|findFirstIndexIndexedOrNull|findIndexIndexedOrNull
find last index
- indexOfLast|findLastIndex
- indexOfLastOrNull|findLastIndexOrNull
- indexOfLastIndexed|findLastIndexIndexed
- indexOfLastIndexedOrNull|findLastIndexIndexedOrNull

The validation methods

Those methods are to give a validation on some type, value or comparison across the collection -

all|every
any|some
none
has …
- hasNull|includesNull|containsNull
- hasDuplicate|includesDuplicate|containsDuplicate
- has|includes|contains
- hasOne|includesOne|containsOne
- hasAll|includesAll|containsAll
requireNotNull

The transformation methods

Those methods have the purpose to give a new collection with a possibly different type from the original collection

filter …
- filter
- filterIndexed
- filterNot
- filterIndexedNot
- filterNotNull
slice …
- slice
take …
- take|limit
- takeWhile|limitWhile
- takeWhileIndexed|limitWhileIndexed
- takeLast|limitLast
- takeLastWhile|limitLastWhile
- takeLastWhileIndexed|limitLastWhileIndexed
drop …
- drop|skip
- dropWhile|skipWhile
- dropWhileIndexed|skipWhileIndexed
- dropLast|skipLast
- dropLastWhile|skipLastWhile
- dropLastWhileIndexed|skipLastWhileIndexed
map …
- map
- mapIndexed
- mapNotNull
- mapNotNullIndexed

The loop methods

Those methods are just doing a basic loop on the collection

forEach
forEachIndexed
onEach
onEachIndexed

The reordering methods

Those methods are just changing the order to the elements of the collection

toReverse|toReversed|reversed

The conversion methods

Those methods have the sole purpose to convert the structure from a collection to another structure. It can also convert the value to a string.

toIterator
toArray
toMutableArray
toSet
toMutableSet
toWeakSet (only if the it is an object|symbol or in GenericObjectCollectionHolder)
toMutableWeakSet (only if it is an object|symbol or in GenericObjectCollectionHolder)
toMap
toMutableMap
toString
toLocaleString
toLowerCaseString
toLocaleLowerCaseString
toUpperCaseString
toLocaleUpperCaseString
joinToString|join

The utility methods

Those methods are not part of the CollectionHolder, but are a complement to the overall robustest of the collection

as … string
- asString (This will be eventually moved in another project)
- asLocaleString (This will be eventually moved in another project)
- asLowerCaseString (This will be eventually moved in another project)
- asLocaleLowerCaseString (This will be eventually moved in another project)
- asUpperCaseString (This will be eventually moved in another project)
- asLocaleUpperCaseString (This will be eventually moved in another project)
is framework collection
- isCollectionHolder
- isCollectionHolderByStructure
- isMinimalistCollectionHolder
- isMinimalistCollectionHoldeByStructure
- isCollectionIterator
- isCollectionIteratorByStructure
is JavaScript collection
- isArray
- isArrayByStructure
- isTypedArray
- isTypedArrayByStructure
- isInt8Array
- isInt8ArrayByStructure
- isUint8Array
- isUint8ArrayByStructure
- isUint8ClampedArray
- isUint8ClampedArrayByStructure
- isInt16Array
- isInt16ArrayByStructure
- isUint16Array
- isUint16ArrayByStructure
- isInt32Array
- isInt32ArrayByStructure
- isUint32Array
- isUint32ArrayByStructure
- isBigInt64Array
- isBigInt64ArrayByStructure
- isBigUint64Array
- isBigUint64ArrayByStructure
- isFloat32Array
- isFloat32ArrayByStructure
- isFloat64Array
- isFloat64ArrayByStructure
- isSet
- isSetByStructure
- isIterator

Non-present methods

Almost every method is present in the src/method at the exception to get(index) and get size() that is handled differently based on the type of instance.

The alias methods are not part of the extension function. are get length() and get count().

Eventually, those methods should be present.

Contribution

You can contribute to great simple packages. All with similar behaviour across different languages (like Java, Kotlin, C# and PHP). It can be done 2 different ways: