1.0.8

npmextra.json

@@ -5,22 +5,20 @@
       "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartarray",
-      "description": "a package exposing async manipulation for arrays",
+      "description": "A TypeScript library for enhancing array manipulation with asynchronous operations such as mapping, filtering, and deduplication.",
       "npmPackagename": "@push.rocks/smartarray",
       "license": "MIT",
       "projectDomain": "push.rocks",
       "keywords": [
-        "async",
+        "TypeScript",
-        "arrays",
+        "asynchronous programming",
-        "manipulation",
+        "array manipulation",
-        "filter",
+        "array mapping",
-        "deduplicate",
+        "array filtering",
-        "typescript",
+        "deduplication",
-        "nodejs",
+        "async/await",
-        "async programming",
+        "software development",
-        "development",
         "npm package",
-        "code quality",
         "open source"
       ]
     }

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@push.rocks/smartarray",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "private": false,
-  "description": "a package exposing async manipulation for arrays",
+  "description": "A TypeScript library for enhancing array manipulation with asynchronous operations such as mapping, filtering, and deduplication.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
@@ -37,17 +37,15 @@
   ],
   "type": "module",
   "keywords": [
-    "async",
+    "TypeScript",
-    "arrays",
+    "asynchronous programming",
-    "manipulation",
+    "array manipulation",
-    "filter",
+    "array mapping",
-    "deduplicate",
+    "array filtering",
-    "typescript",
+    "deduplication",
-    "nodejs",
+    "async/await",
-    "async programming",
+    "software development",
-    "development",
     "npm package",
-    "code quality",
     "open source"
   ]
 }

readme.md

@@ -1,68 +1,109 @@
 # @push.rocks/smartarray
-a package exposing async manipulation for arrays
+
+A library providing asynchronous operations like filter, map, and deduplication for arrays in TypeScript.
 
 ## Install
-To add `@push.rocks/smartarray` to your project, run the following command:
+
+To install `@push.rocks/smartarray` in your project, run the following command:
 
 ```bash
 npm install @push.rocks/smartarray --save
 ```
 
-This will install the package and add it to your project's dependencies. Ensure you have Node.js and npm installed on your machine before running this command.
+Make sure you have Node.js and npm installed beforehand.
 
 ## Usage
 
-`@push.rocks/smartarray` simplifies the manipulation of arrays with asynchronous operations in TypeScript. It provides utility functions such as filtering and deduplication of arrays with asynchronous predicates or key generation functions. Let's delve into code examples to understand how to utilize these features effectively.
+The `@push.rocks/smartarray` library is designed to facilitate asynchronous array operations in TypeScript projects. It simplifies tasks like mapping, filtering, and deduplication by embracing async/await patterns, making it an invaluable tool for modern JavaScript development. Below, we delve into the capabilities of this library, providing comprehensive examples to illustrate its use in a variety of scenarios.
 
-### Importing the module
+### Importing the Library
 
-First, import the functions you need from the module:
+Before you can utilize the library's functions, you need to import them into your TypeScript files. Depending on your use case, you can import specific functions or the entire library:
 
 ```typescript
-import { filter, deduplicate } from '@push.rocks/smartarray';
+import { map, filter, deduplicate } from '@push.rocks/smartarray';
 ```
 
-### Filtering an Array Asynchronously
+### Async Map: Transforming Arrays
 
-The `filter` function allows you to filter an array based on a predicate function that returns a Promise. This is particularly useful when your filtering condition involves asynchronous operations, such as fetching data from an API or accessing a database.
+The `map` function lets you apply an asynchronous operation to each item in an array, constructing a new array with the transformed items.
 
-Suppose you have an array of user IDs, and you want to filter out IDs that do not correspond to active users. You might have an asynchronous function `isActiveUser(userId): Promise<boolean>` that checks user's status. Here's how you can filter out inactive user IDs:
+#### Example: Doubling Numbers
 
 ```typescript
-const userIds = [1, 2, 3, 4, 5];
+const numbers = [1, 2, 3, 4];
-const activeUserIds = await filter(userIds, async (userId) => {
+const doubleNumbers = await map(numbers, async (number) => number * 2);
-  return isActiveUser(userId);
+console.log(doubleNumbers); // Output: [2, 4, 6, 8]
-});
-console.log(activeUserIds); // Logs: [1, 3, 5] assuming these IDs are active
 ```
 
-### Deduplicating an Array Asynchronously
+#### Async Filter: Conditional Array Traversal
 
-The `deduplicate` function removes duplicate elements from an array based on a key generated by an asynchronous function. This is handy when you need to remove duplicates based on complex or asynchronous criteria.
+With the `filter` function, you can asynchronously judge whether to keep or remove items from the array.
 
-Imagine you have an array of objects representing job applications, where each object contains a `userId` and `applicationId`. If you want to ensure that there's only one application per user, you could use the `deduplicate` function as shown:
+#### Example: Filtering Even Numbers
 
 ```typescript
-const applications = [
+const numbers = [1, 2, 3, 4, 5, 6];
-  { userId: 1, applicationId: 'a1' },
+const evenNumbers = await filter(numbers, async (number) => number % 2 === 0);
-  { userId: 2, applicationId: 'a2' },
+console.log(evenNumbers); // Output: [2, 4, 6]
-  { userId: 1, applicationId: 'a3' }, // Duplicate user
+```
-  { userId: 3, applicationId: 'a4' }
+
+### Async Deduplicate: Removing Duplication
+
+The `deduplicate` function excels in removing duplicates from an array based on asynchronously derived unique keys for each element.
+
+#### Example: Deduplicating User Array
+
+```typescript
+const users = [
+  { id: 1, name: 'John' },
+  { id: 2, name: 'Jane' },
+  { id: 1, name: 'John' }
+];
+const deduplicatedUsers = await deduplicate(users, async (user) => user.id);
+console.log(deduplicatedUsers);
+// Output: [{ id: 1, name: 'John' }, { id: 2, name: 'Jane' }]
+```
+
+### Deep-Dive Use Cases
+
+#### Complex Data Transformation
+
+Imagine you're working with a dataset of user objects fetched from an API, and you need to perform several transformations: filter out inactive users, double the user IDs for a new report, and ensure the list is deduplicated based on usernames.
+
+```typescript
+import { map, filter, deduplicate } from '@push.rocks/smartarray';
+
+// Example users array
+const users = [
+  { id: 1, active: true, username: 'user1' },
+  { id: 2, active: false, username: 'user2' },
+  { id: 3, active: true, username: 'user3' },
+  { id: 1, active: true, username: 'user1' } // Duplicate for demonstration
 ];
 
-const uniqueApplications = await deduplicate(applications, async (app) => {
+// First, filter out inactive users
-  // The key is the userId, ensuring uniqueness by user
+const activeUsers = await filter(users, async (user) => user.active);
-  return app.userId;
-});
 
-console.log(uniqueApplications);
+// Next, transform the user IDs
-// Logs: [{ userId: 1, applicationId: 'a1' }, { userId: 2, applicationId: 'a2' }, { userId: 3, applicationId: 'a4' }]
+const transformedUsers = await map(activeUsers, async (user) => ({
+  ...user,
+  id: user.id * 2
+}));
+
+// Finally, deduplicate based on usernames
+const uniqueUsers = await deduplicate(transformedUsers, async (user) => user.username);
+
+console.log(uniqueUsers);
 ```
-In this example, the second application from the same user (`userId: 1`) was removed, leaving only unique user applications in the array.
 
-These examples illustrate how `@push.rocks/smartarray` can be utilized for asynchronous array manipulation, offering flexibility and performance for handling complex data processing tasks in a modern JavaScript or TypeScript application.
+This example demonstrates `@push.rocks/smartarray`'s power in handling complex, asynchronous data operations in an efficient, readable manner. By chaining these methods, you can achieve sophisticated data manipulation objectives with minimal code.
 
-Remember, all operations return promises, so ensure you handle them properly using `async/await` syntax or `.then().catch()` chains according to your application's structure or personal preference.
+### Conclusion
+
+`@push.rocks/smartarray` significantly simplifies the development experience when working with arrays in asynchronous environments. It not only enhances readability and maintainability but also ensures that your codebase remains scalable and efficient. By integrating this library into your projects, you unlock a higher level of programming paradigm where array manipulations are no longer a chore but a streamlined process.
+
+For developers aiming to harness the full potential of asynchronous operations in TypeScript, `@push.rocks/smartarray` offers a comprehensive, easy-to-use solution that stands out for its performance and versatility. Whether you’re mapping, filtering, or deduplicating arrays, this library empowers you to write cleaner, more efficient code, elevating your development workflow to new heights.
 
 ## License and Legal Information
 

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartarray',
-  version: '1.0.6',
+  version: '1.0.8',
-  description: 'a package exposing async manipulation for arrays'
+  description: 'A TypeScript library for enhancing array manipulation with asynchronous operations such as mapping, filtering, and deduplication.'
 }