Compare commits
No commits in common. "master" and "v1.0.5" have entirely different histories.
@ -119,6 +119,6 @@ jobs:
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @git.zone/tsdoc
|
||||
pnpm install -g @gitzone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
|
||||
@ -121,7 +121,7 @@ pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @git.zone/tsdoc
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
|
||||
29
changelog.md
29
changelog.md
@ -1,29 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-01-04 - 1.1.0 - feat(core)
|
||||
Add concurrent processing support
|
||||
|
||||
- Introduced ConcurrentProcessor class for handling asynchronous operations with a concurrency limit.
|
||||
|
||||
## 2024-05-29 - 1.0.8 - Documentation
|
||||
Updated project description for clarity and accuracy.
|
||||
|
||||
- Enhanced documentation details in the project description.
|
||||
|
||||
## 2024-04-01 to 2024-04-27 - 1.0.5 to 1.0.7 - Maintenance and Configuration Updates
|
||||
Multiple updates focusing on configuration and core functionality.
|
||||
|
||||
- Updated `tsconfig` for improved TypeScript setup.
|
||||
- Refined `npmextra.json` to configure `githost`.
|
||||
- Applied numerous core functionality enhancements and fixes.
|
||||
|
||||
## 2023-07-10 to 2023-08-02 - 1.0.3 to 1.0.4 - Organizational Changes and Fixes
|
||||
Transition to new organizational structure and related updates.
|
||||
|
||||
- Implemented a new organizational scheme for the project.
|
||||
- Applied essential fixes to core components ensuring stability.
|
||||
|
||||
## 2021-06-29 to 2021-06-30 - 1.0.1 to 1.0.2 - Core Fixes
|
||||
Addressed core system updates and enhancements.
|
||||
|
||||
- Implemented bug fixes to enhance core functionality.
|
||||
@ -2,32 +2,17 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartarray",
|
||||
"description": "A TypeScript library for enhancing array manipulation with asynchronous operations such as mapping, filtering, and deduplication.",
|
||||
"description": "a package exposing async manipulation for arrays",
|
||||
"npmPackagename": "@push.rocks/smartarray",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"TypeScript",
|
||||
"asynchronous programming",
|
||||
"array manipulation",
|
||||
"array mapping",
|
||||
"array filtering",
|
||||
"deduplication",
|
||||
"async/await",
|
||||
"software development",
|
||||
"npm package",
|
||||
"open source"
|
||||
]
|
||||
"projectDomain": "push.rocks"
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
35
package.json
35
package.json
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "@push.rocks/smartarray",
|
||||
"version": "1.1.0",
|
||||
"version": "1.0.5",
|
||||
"private": false,
|
||||
"description": "A TypeScript library for enhancing array manipulation with asynchronous operations such as mapping, filtering, and deduplication.",
|
||||
"description": "a package exposing async manipulation for arrays",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
@ -13,12 +13,12 @@
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.2.0",
|
||||
"@git.zone/tsbundle": "^2.1.0",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.5.4",
|
||||
"@types/node": "^22.10.5"
|
||||
"@gitzone/tsbuild": "^2.1.66",
|
||||
"@gitzone/tsbundle": "^2.0.8",
|
||||
"@gitzone/tsrun": "^1.2.44",
|
||||
"@gitzone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.12",
|
||||
"@types/node": "^20.4.6"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
@ -35,22 +35,5 @@
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"type": "module",
|
||||
"keywords": [
|
||||
"TypeScript",
|
||||
"asynchronous programming",
|
||||
"array manipulation",
|
||||
"array mapping",
|
||||
"array filtering",
|
||||
"deduplication",
|
||||
"async/await",
|
||||
"software development",
|
||||
"npm package",
|
||||
"open source"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/smartarray",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/smartarray.git"
|
||||
}
|
||||
"type": "module"
|
||||
}
|
||||
|
||||
10998
pnpm-lock.yaml
generated
10998
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
||||
|
||||
140
readme.md
140
readme.md
@ -1,125 +1,37 @@
|
||||
# @push.rocks/smartarray
|
||||
a package exposing async manipulation for arrays
|
||||
|
||||
A library providing asynchronous operations like filter, map, and deduplication for arrays in TypeScript.
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartarray)
|
||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartarray)
|
||||
* [github.com (source mirror)](https://github.com/push.rocks/smartarray)
|
||||
* [docs (typedoc)](https://push.rocks.gitlab.io/smartarray/)
|
||||
|
||||
## Install
|
||||
## Status for master
|
||||
|
||||
To install `@push.rocks/smartarray` in your project, run the following command:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartarray --save
|
||||
```
|
||||
|
||||
Make sure you have Node.js and npm installed beforehand.
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
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.
|
||||
Use TypeScript for best in class intellisense
|
||||
|
||||
### Importing the Library
|
||||
## Contribution
|
||||
|
||||
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:
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
|
||||
```typescript
|
||||
import { map, filter, deduplicate } from '@push.rocks/smartarray';
|
||||
```
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
### Async Map: Transforming Arrays
|
||||
|
||||
The `map` function lets you apply an asynchronous operation to each item in an array, constructing a new array with the transformed items.
|
||||
|
||||
#### Example: Doubling Numbers
|
||||
|
||||
```typescript
|
||||
const numbers = [1, 2, 3, 4];
|
||||
const doubleNumbers = await map(numbers, async (number) => number * 2);
|
||||
console.log(doubleNumbers); // Output: [2, 4, 6, 8]
|
||||
```
|
||||
|
||||
#### Async Filter: Conditional Array Traversal
|
||||
|
||||
With the `filter` function, you can asynchronously judge whether to keep or remove items from the array.
|
||||
|
||||
#### Example: Filtering Even Numbers
|
||||
|
||||
```typescript
|
||||
const numbers = [1, 2, 3, 4, 5, 6];
|
||||
const evenNumbers = await filter(numbers, async (number) => number % 2 === 0);
|
||||
console.log(evenNumbers); // Output: [2, 4, 6]
|
||||
```
|
||||
|
||||
### 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
|
||||
];
|
||||
|
||||
// First, filter out inactive users
|
||||
const activeUsers = await filter(users, async (user) => user.active);
|
||||
|
||||
// Next, transform the user IDs
|
||||
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);
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
### 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
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartarray',
|
||||
version: '1.1.0',
|
||||
description: 'A TypeScript library for enhancing array manipulation with asynchronous operations such as mapping, filtering, and deduplication.'
|
||||
version: '1.0.5',
|
||||
description: 'a package exposing async manipulation for arrays'
|
||||
}
|
||||
|
||||
@ -1,35 +0,0 @@
|
||||
export class ConcurrentProcessor<T> {
|
||||
private asyncFunction: (item: T) => Promise<void>;
|
||||
private concurrencyLimit: number;
|
||||
|
||||
constructor(asyncFunction: (item: T) => Promise<void>, concurrencyLimit: number) {
|
||||
this.asyncFunction = asyncFunction;
|
||||
this.concurrencyLimit = concurrencyLimit;
|
||||
}
|
||||
|
||||
async process(items: T[]): Promise<void> {
|
||||
const queue: Array<Promise<void>> = [];
|
||||
let totalProcessed = 0;
|
||||
|
||||
for (const item of items) {
|
||||
const promise = this.asyncFunction(item).then(() => {
|
||||
totalProcessed++;
|
||||
if (totalProcessed % 10000 === 0) {
|
||||
console.log(`${totalProcessed} items processed.`);
|
||||
}
|
||||
// Remove the completed promise from the queue
|
||||
queue.splice(queue.indexOf(promise), 1);
|
||||
});
|
||||
|
||||
queue.push(promise);
|
||||
|
||||
// Wait if the number of promises exceeds the concurrency limit
|
||||
if (queue.length >= this.concurrencyLimit) {
|
||||
await Promise.race(queue);
|
||||
}
|
||||
}
|
||||
|
||||
// Wait for the remaining promises to resolve
|
||||
await Promise.all(queue);
|
||||
}
|
||||
}
|
||||
16
ts/index.ts
16
ts/index.ts
@ -1,19 +1,3 @@
|
||||
export * from './classes.concurrentprocessor.js';
|
||||
|
||||
export const map = async <T = any, R = any>(
|
||||
arrayArg: T[],
|
||||
mapFunction: (itemArg: T) => Promise<R>
|
||||
): Promise<R[]> => {
|
||||
const returnArray: R[] = [];
|
||||
for (const itemArg of arrayArg) {
|
||||
const mapResult = await mapFunction(itemArg);
|
||||
if (mapResult !== undefined) {
|
||||
returnArray.push(mapResult);
|
||||
}
|
||||
}
|
||||
return returnArray;
|
||||
};
|
||||
|
||||
export const filter = async <T>(
|
||||
arrayArg: T[],
|
||||
filterFunction: (itemArg: T) => Promise<boolean>
|
||||
|
||||
@ -3,12 +3,9 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
"verbatimModuleSyntax": true,
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user