Compare commits
No commits in common. "master" and "v4.0.0" have entirely different histories.
128
.gitlab-ci.yml
Normal file
128
.gitlab-ci.yml
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
# gitzone ci_default
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- security
|
||||||
|
- test
|
||||||
|
- release
|
||||||
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- pnpm install -g pnpm
|
||||||
|
- pnpm install -g @shipzone/npmci
|
||||||
|
- npmci npm prepare
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command pnpm audit --audit-level=high --prod
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command pnpm audit --audit-level=high --dev
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testStable:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
testBuild:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm build
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
release:
|
||||||
|
stage: release
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run buildDocs
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
||||||
122
changelog.md
122
changelog.md
@ -1,122 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 2025-02-20 - 4.2.3 - fix(test)
|
|
||||||
Refactor test suite for improved readability and maintainability.
|
|
||||||
|
|
||||||
- Updated and cleaned up test cases for deferreds and promises.
|
|
||||||
- Reduced timeouts in tests for quicker execution.
|
|
||||||
- Added expectations for promise status and duration.
|
|
||||||
|
|
||||||
## 2025-02-20 - 4.2.3 - fix(test)
|
|
||||||
Refactor test suite for improved readability and maintainability.
|
|
||||||
|
|
||||||
- Updated and cleaned up test cases for deferreds and promises.
|
|
||||||
- Reduced timeouts in tests for quicker execution.
|
|
||||||
- Added expectations for promise status and duration.
|
|
||||||
|
|
||||||
## 2025-01-23 - 4.2.2 - fix(dependencies)
|
|
||||||
Update @git.zone/tstest and @types/node dependencies to latest versions
|
|
||||||
|
|
||||||
- Updated @git.zone/tstest from ^1.0.91 to ^1.0.92
|
|
||||||
- Updated @types/node from ^22.10.9 to ^22.10.10
|
|
||||||
|
|
||||||
## 2025-01-23 - 4.2.1 - fix(devDependencies)
|
|
||||||
Update development dependencies to latest versions
|
|
||||||
|
|
||||||
- Updated @git.zone/tstest to version ^1.0.91
|
|
||||||
- Updated @push.rocks/tapbundle to version ^5.5.6
|
|
||||||
- Updated @types/node to version ^22.10.9
|
|
||||||
|
|
||||||
## 2025-01-19 - 4.2.0 - feat(cumulativedeferred)
|
|
||||||
Added subDefer method to CumulativeDeferred
|
|
||||||
|
|
||||||
- Introduced `subDefer` method in CumulativeDeferred class to allow creating and adding new Deferreds easily.
|
|
||||||
|
|
||||||
## 2025-01-07 - 4.1.0 - feat(core)
|
|
||||||
Add fromCallback utility function for promisifying Node.js-style callback functions
|
|
||||||
|
|
||||||
- Added fromCallback function to convert Node.js-style callbacks into Promises.
|
|
||||||
|
|
||||||
## 2024-06-23 - 4.0.4 - fix(ci)
|
|
||||||
Remove .gitlab-ci.yml and update dependencies and metadata
|
|
||||||
|
|
||||||
- Removed .gitlab-ci.yml file
|
|
||||||
- Updated dependencies in package.json and npmextra.json
|
|
||||||
- Improved description and keywords for better package definition
|
|
||||||
|
|
||||||
## 2024-05-29 - 4.0.3 - Maintenance
|
|
||||||
Update project configuration and descriptions.
|
|
||||||
|
|
||||||
- Update project description
|
|
||||||
- Update tsconfig
|
|
||||||
- Update npmextra.json with githost field
|
|
||||||
|
|
||||||
## 2023-07-10 - 4.0.2 - Standards
|
|
||||||
Updates to adhere to new organizational standards.
|
|
||||||
|
|
||||||
- Switch to new org scheme
|
|
||||||
- Fix(core): update project settings
|
|
||||||
|
|
||||||
## 2023-04-17 - 4.0.0 - Major Release
|
|
||||||
Significant updates and switching to ESM.
|
|
||||||
|
|
||||||
- Fix(core): update project settings
|
|
||||||
|
|
||||||
## 2023-04-04 - 3.1.9 - Major Release
|
|
||||||
Breaking change: switch to ESM (ECMAScript Module).
|
|
||||||
|
|
||||||
## 2021-05-31 - 3.1.6 - Maintenance
|
|
||||||
Update project settings.
|
|
||||||
|
|
||||||
- Fix(core): update project settings
|
|
||||||
|
|
||||||
## 2021-04-23 - 3.1.4 - Maintenance
|
|
||||||
Update project settings.
|
|
||||||
|
|
||||||
- Fix(core): update project settings
|
|
||||||
|
|
||||||
## 2020-10-16 - 3.1.2 - Maintenance
|
|
||||||
Update project settings.
|
|
||||||
|
|
||||||
- Fix(core): update project settings
|
|
||||||
|
|
||||||
## 2020-10-15 - 3.0.9 - Feature
|
|
||||||
Added functionality for wrapping promises in timeouts.
|
|
||||||
|
|
||||||
- Feat(timeouts): allows the wrapping of promises in timeouts
|
|
||||||
|
|
||||||
## 2019-10-01 - 3.0.5 - Maintenance
|
|
||||||
Update project settings.
|
|
||||||
|
|
||||||
- Fix(core): update project settings
|
|
||||||
|
|
||||||
## 2019-03-26 - 3.0.0 - Major Release
|
|
||||||
Breaking change: remove util dependency.
|
|
||||||
|
|
||||||
- BREAKING CHANGE(remove util dependency and promisify functionality): update
|
|
||||||
|
|
||||||
## 2018-07-03 - 2.0.2 - Dependencies
|
|
||||||
Project now has zero dependencies.
|
|
||||||
|
|
||||||
- Fix(core): now has 0 dependencies
|
|
||||||
|
|
||||||
## 2018-03-16 - 1.1.8 - Major Release
|
|
||||||
Breaking change: switch scope to pushrocks.
|
|
||||||
|
|
||||||
- BREAKING CHANGE(scope): switch scope to pushrocks
|
|
||||||
|
|
||||||
## 2017-07-27 - 1.1.7 - Standards
|
|
||||||
Update to latest coding standards.
|
|
||||||
|
|
||||||
- Update to latest standards
|
|
||||||
|
|
||||||
## 2017-07-06 - 1.1.4 - Features and Improvements
|
|
||||||
Added polyfill and npmextra.json.
|
|
||||||
|
|
||||||
- Add polyfill
|
|
||||||
- Add npmextra.json
|
|
||||||
|
|
||||||
## 2017-07-06 - 1.1.2 - CI Maintenance
|
|
||||||
Updated continuous integration configuration.
|
|
||||||
|
|
||||||
- Update ci
|
|
||||||
@ -6,26 +6,12 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "code.foss.global",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartpromise",
|
"gitrepo": "smartpromise",
|
||||||
"description": "A TypeScript library for managing promises and Deferred constructs, simplifying asynchronous programming.",
|
"description": "simple promises and Deferred constructs",
|
||||||
"npmPackagename": "@push.rocks/smartpromise",
|
"npmPackagename": "@pushrocks/smartpromise",
|
||||||
"license": "MIT",
|
"license": "MIT"
|
||||||
"keywords": [
|
}
|
||||||
"promise",
|
|
||||||
"deferred",
|
|
||||||
"async",
|
|
||||||
"promisify",
|
|
||||||
"cumulative deferred",
|
|
||||||
"timeout",
|
|
||||||
"typescript",
|
|
||||||
"asynchronous",
|
|
||||||
"utilities"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"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"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
40
package.json
40
package.json
@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartpromise",
|
"name": "@pushrocks/smartpromise",
|
||||||
"private": false,
|
"private": false,
|
||||||
"version": "4.2.3",
|
"version": "4.0.0",
|
||||||
"description": "A TypeScript library for managing promises and Deferred constructs, simplifying asynchronous programming.",
|
"description": "simple promises and Deferred constructs",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@ -12,20 +12,20 @@
|
|||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://code.foss.global/push.rocks/smartpromise.git"
|
"url": "git+ssh://git@gitlab.com/pushrocks/smartq.git"
|
||||||
},
|
},
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/pushrocks/smartq/issues"
|
"url": "https://gitlab.com/pushrocks/smartq/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://code.foss.global/push.rocks/smartpromise",
|
"homepage": "https://gitlab.com/pushrocks/smartq#README",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.2.0",
|
"@gitzone/tsbuild": "^2.1.65",
|
||||||
"@git.zone/tsrun": "^1.3.3",
|
"@gitzone/tsrun": "^1.2.39",
|
||||||
"@git.zone/tstest": "^1.0.92",
|
"@gitzone/tstest": "^1.0.74",
|
||||||
"@push.rocks/tapbundle": "^5.5.6",
|
"@pushrocks/tapbundle": "^5.0.4",
|
||||||
"@types/node": "^22.10.10"
|
"@types/node": "^18.15.11"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@ -42,23 +42,5 @@
|
|||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
],
|
],
|
||||||
"type": "module",
|
"type": "module"
|
||||||
"keywords": [
|
|
||||||
"promise",
|
|
||||||
"deferred",
|
|
||||||
"async",
|
|
||||||
"promisify",
|
|
||||||
"cumulative deferred",
|
|
||||||
"timeout",
|
|
||||||
"typescript",
|
|
||||||
"asynchronous",
|
|
||||||
"utilities"
|
|
||||||
],
|
|
||||||
"pnpm": {
|
|
||||||
"onlyBuiltDependencies": [
|
|
||||||
"esbuild",
|
|
||||||
"mongodb-memory-server",
|
|
||||||
"puppeteer"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
11635
pnpm-lock.yaml
generated
11635
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
|||||||
|
|
||||||
361
readme.md
361
readme.md
@ -1,311 +1,96 @@
|
|||||||
# @push.rocks/smartpromise
|
# @pushrocks/smartpromise
|
||||||
|
simple promises and Deferred constructs
|
||||||
|
|
||||||
A library for simple promises and Deferred constructs with TypeScript support.
|
## Availabililty and Links
|
||||||
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpromise)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartpromise)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartpromise)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartpromise/)
|
||||||
|
|
||||||
## Install
|
## Status for master
|
||||||
|
|
||||||
```bash
|
Status Category | Status Badge
|
||||||
npm install @push.rocks/smartpromise --save
|
-- | --
|
||||||
```
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
This module is designed to be used with TypeScript for the best developer experience, providing type safety and IntelliSense in your IDE.
|
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
|
## Usage
|
||||||
|
|
||||||
`@push.rocks/smartpromise` simplifies the use of promises and deferred constructs in TypeScript, offering a set of utility functions that extend native Promise capabilities in specific scenarios. This guide walks you through its functionalities, showcasing how to leverage this library in a TypeScript project.
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
### Setting Up Your Project
|
> Note: smartq uses native ES6 promises
|
||||||
|
> smartq does not repeat any native functions, so for things like .all() simply use Promise.all()
|
||||||
Ensure your TypeScript project is configured to support ES Module syntax. In your `tsconfig.json`, you should have:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"module": "ESNext",
|
|
||||||
"target": "ESNext",
|
|
||||||
"moduleResolution": "node"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Basic Usage
|
|
||||||
|
|
||||||
#### Creating a Deferred
|
|
||||||
|
|
||||||
Deferred objects in `@push.rocks/smartpromise` give you more control over your promises, allowing for manual resolution or rejection beyond the initial executor function.
|
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { defer } from '@push.rocks/smartpromise';
|
import * as q from '@pushrocks/smartpromise';
|
||||||
|
|
||||||
async function exampleDeferred(): Promise<string> {
|
// Deferred
|
||||||
const myDeferred = defer<string>();
|
// -----------------------------------------------
|
||||||
|
let myAsyncFunction = (): Promise<string> => {
|
||||||
// Simulate an async task
|
let done = q.defer<string>(); // returns your typical Deferred object
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
myDeferred.resolve('Hello, Deferred!');
|
done.resolve('hi'); // will throw type error for other types than string as argument ;)
|
||||||
}, 1000);
|
}, 6000);
|
||||||
|
|
||||||
return myDeferred.promise;
|
console.log(done.status); // logs "pending";
|
||||||
}
|
done.promise.then(() => {
|
||||||
|
console.log(done.status); // logs "fullfilled"
|
||||||
exampleDeferred().then((result) => console.log(result));
|
console.log(done.duration); // logs the milliseconds between instantiation and fullfillment
|
||||||
```
|
|
||||||
|
|
||||||
#### Cumulative Deferred
|
|
||||||
|
|
||||||
For scenarios where multiple asynchronous tasks need to be tracked collectively before proceeding, use `CumulativeDeferred`. It waits for all added promises to resolve.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { cumulativeDefer } from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
async function exampleCumulativeDeferred() {
|
|
||||||
const myCumulativeDeferred = cumulativeDefer();
|
|
||||||
|
|
||||||
for (let i = 0; i < 5; i++) {
|
|
||||||
myCumulativeDeferred.addPromise(new Promise((resolve) => setTimeout(resolve, 1000 * i)));
|
|
||||||
}
|
|
||||||
|
|
||||||
await myCumulativeDeferred.promise;
|
|
||||||
console.log('All tasks completed!');
|
|
||||||
}
|
|
||||||
|
|
||||||
exampleCumulativeDeferred();
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Utilizing Resolved and Rejected Promises
|
|
||||||
|
|
||||||
Quickly create already resolved or rejected promises for testing or initialization purposes.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { resolvedPromise, rejectedPromise } from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
resolvedPromise('immediately resolved').then(console.log);
|
|
||||||
rejectedPromise('immediately rejected').catch(console.error);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Advanced Use Cases
|
|
||||||
|
|
||||||
#### Promisify Callback Functions
|
|
||||||
|
|
||||||
`@push.rocks/smartpromise` does not directly provide a `promisify` function like Node.js `util` module, but you can easily integrate existing functions or use third-party libraries to convert callback-based functions into promises.
|
|
||||||
|
|
||||||
#### Handling Timeouts and Continuations
|
|
||||||
|
|
||||||
Managing timeouts or long-running promises gets easier with helper functions.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { timeoutWrap, timeoutAndContinue } from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
async function exampleTimeout() {
|
|
||||||
const myPromise = new Promise((resolve) => setTimeout(() => resolve('Done!'), 2000));
|
|
||||||
|
|
||||||
// Will reject if the promise does not resolve within 1 second
|
|
||||||
try {
|
|
||||||
const result = await timeoutWrap(myPromise, 1000);
|
|
||||||
console.log(result);
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Promise timed out');
|
|
||||||
}
|
|
||||||
|
|
||||||
// Continues after 1 second, regardless of whether the promise has resolved
|
|
||||||
const result = await timeoutAndContinue(myPromise, 1000);
|
|
||||||
console.log(result); // May log `null` if the original promise did not resolve in time
|
|
||||||
}
|
|
||||||
|
|
||||||
exampleTimeout();
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Map and Reduce Asynchronous Functions
|
|
||||||
|
|
||||||
Suppose you have a collection of items that you need to process asynchronously. You can use the `map` function to apply an asynchronous function to each item in the array and wait for all the promises to resolve.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { map } from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
async function processData(items: string[]): Promise<string[]> {
|
|
||||||
return map(items, async (item) => {
|
|
||||||
// Simulate an async operation
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, 100));
|
|
||||||
return item.toUpperCase();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
processData(['hello', 'world']).then(console.log);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Handling Complex Promise Scenarios
|
|
||||||
|
|
||||||
#### Managing Multiple Deferreds
|
|
||||||
|
|
||||||
If you have multiple deferred objects and you want to manage them collectively, you can do so using the `CumulativeDeferred` class. This is especially useful when you have a dynamic number of deferreds to resolve.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { defer, cumulativeDefer } from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
async function exampleComplexDeferred(): Promise<void> {
|
|
||||||
const task1 = defer<string>();
|
|
||||||
const task2 = defer<string>();
|
|
||||||
const cumulative = cumulativeDefer();
|
|
||||||
|
|
||||||
cumulative.addPromise(task1.promise);
|
|
||||||
cumulative.addPromise(task2.promise);
|
|
||||||
|
|
||||||
// Simulate async tasks
|
|
||||||
setTimeout(() => task1.resolve('Task 1 complete'), 1000);
|
|
||||||
setTimeout(() => task2.resolve('Task 2 complete'), 2000);
|
|
||||||
|
|
||||||
await cumulative.promise;
|
|
||||||
|
|
||||||
console.log('All tasks completed');
|
|
||||||
}
|
|
||||||
|
|
||||||
exampleComplexDeferred();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Other Utilities
|
|
||||||
|
|
||||||
#### Race Condition Handling with `getFirstTrueOrFalse`
|
|
||||||
|
|
||||||
This helper function resolves immediately when one of the provided promises resolves to `true` or when all promises are resolved to `false`.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { getFirstTrueOrFalse } from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
async function exampleRaceCondition() {
|
|
||||||
const task1 = new Promise<boolean>((resolve) => setTimeout(() => resolve(true), 1000));
|
|
||||||
const task2 = new Promise<boolean>((resolve) => setTimeout(() => resolve(false), 2000));
|
|
||||||
|
|
||||||
const result = await getFirstTrueOrFalse([task1, task2]);
|
|
||||||
console.log(result); // Outputs: true
|
|
||||||
}
|
|
||||||
|
|
||||||
exampleRaceCondition();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Complete Use Case
|
|
||||||
|
|
||||||
Let's create a comprehensive example that showcases multiple features of `@push.rocks/smartpromise`.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import {
|
|
||||||
defer,
|
|
||||||
cumulativeDefer,
|
|
||||||
resolvedPromise,
|
|
||||||
rejectedPromise,
|
|
||||||
timeoutWrap,
|
|
||||||
timeoutAndContinue,
|
|
||||||
map,
|
|
||||||
getFirstTrueOrFalse,
|
|
||||||
} from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
async function completeUseCaseExample() {
|
|
||||||
console.log('Starting Complete Use Case Example!');
|
|
||||||
|
|
||||||
// Using Deferred
|
|
||||||
const myDeferred = defer<string>();
|
|
||||||
setTimeout(() => myDeferred.resolve('Deferred Resolved!'), 500);
|
|
||||||
console.log(await myDeferred.promise); // Outputs: "Deferred Resolved!"
|
|
||||||
|
|
||||||
// Using Cumulative Deferred
|
|
||||||
const myCumulativeDeferred = cumulativeDefer();
|
|
||||||
myCumulativeDeferred.addPromise(new Promise((resolve) => setTimeout(() => resolve('Task 1'), 1000)));
|
|
||||||
myCumulativeDeferred.addPromise(new Promise((resolve) => setTimeout(() => resolve('Task 2'), 2000)));
|
|
||||||
await myCumulativeDeferred.promise;
|
|
||||||
console.log('All cumulative tasks completed');
|
|
||||||
|
|
||||||
// Using Resolved and Rejected Promises
|
|
||||||
await resolvedPromise('Instant Resolve').then(console.log); // Outputs: "Instant Resolve"
|
|
||||||
await rejectedPromise('Instant Reject').catch(console.error); // Outputs: "Instant Reject"
|
|
||||||
|
|
||||||
// Using timeoutWrap
|
|
||||||
try {
|
|
||||||
const delayedPromise = new Promise((resolve) => setTimeout(() => resolve('Finished'), 3000));
|
|
||||||
const result = await timeoutWrap(delayedPromise, 1000);
|
|
||||||
console.log(result);
|
|
||||||
} catch (e) {
|
|
||||||
console.error('Timeout occurred'); // Outputs: "Timeout occurred"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Using timeoutAndContinue
|
|
||||||
const resultContinue = await timeoutAndContinue(
|
|
||||||
new Promise((resolve) => setTimeout(() => resolve('Finished eventually'), 3000)),
|
|
||||||
1000
|
|
||||||
);
|
|
||||||
console.log(resultContinue); // Outputs: null (since it didn't resolve in 1 second)
|
|
||||||
|
|
||||||
// Using Map
|
|
||||||
const items = ['a', 'b', 'c'];
|
|
||||||
const processedItems = await map(items, async (item) => {
|
|
||||||
await new Promise((resolve) => setTimeout(resolve, 500));
|
|
||||||
return item.toUpperCase();
|
|
||||||
});
|
|
||||||
console.log(processedItems); // Outputs: ['A', 'B', 'C']
|
|
||||||
|
|
||||||
// Using getFirstTrueOrFalse
|
|
||||||
const raceResults = await getFirstTrueOrFalse([
|
|
||||||
new Promise<boolean>((resolve) => setTimeout(() => resolve(false), 1000)),
|
|
||||||
new Promise<boolean>((resolve) => setTimeout(() => resolve(true), 2000)),
|
|
||||||
]);
|
|
||||||
console.log(raceResults); // Outputs: true
|
|
||||||
|
|
||||||
console.log('Complete Use Case Example Finished!');
|
|
||||||
}
|
|
||||||
|
|
||||||
completeUseCaseExample();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Testing Your Code
|
|
||||||
|
|
||||||
Testing is crucial to ensure the reliability of your asynchronous workflows. You can write tests using the `@push.rocks/tapbundle` library to create unit tests for your promises and deferred constructs.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
|
||||||
import * as smartpromise from '@push.rocks/smartpromise';
|
|
||||||
|
|
||||||
tap.test('should resolve a deferred promise', async () => {
|
|
||||||
const deferred = smartpromise.defer<string>();
|
|
||||||
deferred.resolve('Resolved!');
|
|
||||||
const result = await deferred.promise;
|
|
||||||
expect(result).toEqual('Resolved!');
|
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should timeout a long-running promise', async () => {
|
return done.promise;
|
||||||
const longRunningPromise = new Promise((resolve) => setTimeout(resolve, 2000));
|
};
|
||||||
try {
|
|
||||||
await smartpromise.timeoutWrap(longRunningPromise, 1000);
|
let myAsyncFunction2 = async () => {
|
||||||
} catch (err) {
|
let aString = await myAsyncFunction();
|
||||||
expect(err.message).toEqual('timeout');
|
console.log(aString); // will log 'hi' to console
|
||||||
}
|
};
|
||||||
|
|
||||||
|
myAsyncFunction2();
|
||||||
|
|
||||||
|
// Resolved and Rejected promises
|
||||||
|
// ------------------------------------------------
|
||||||
|
q.resolvedPromise(`I'll get logged to console soon`).then((x) => {
|
||||||
|
console.log(x);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should map async function to an array', async () => {
|
q.rejectedPromise(`what a lovely error message`)
|
||||||
const inputArray = ['a', 'b'];
|
.then(
|
||||||
const result = await smartpromise.map(inputArray, async (item) => item.toUpperCase());
|
() => {
|
||||||
expect(result).toEqual(['A', 'B']);
|
console.log('This never makes it to console');
|
||||||
|
} /*, alternatively put a reject function here */
|
||||||
|
)
|
||||||
|
.catch((err) => {
|
||||||
|
console.log(err);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.start();
|
// Promisify (typed)
|
||||||
|
// ------------------------------------------------
|
||||||
|
|
||||||
|
let myCallbackedFunction = (someString: string, someNumber: number, cb) => {
|
||||||
|
cb(null, someString);
|
||||||
|
};
|
||||||
|
|
||||||
|
let myPromisedFunction = q.promisify(myCallbackFunction);
|
||||||
|
myPromisedFunction('helloThere', 2).then((x) => {
|
||||||
|
console.log(x); // will log 'helloThere' to console
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
By following this guide and using the examples provided, you should be able to effectively use `@push.rocks/smartpromise` for managing promises and deferred constructs in your TypeScript project. The library's extensive utility functions, combined with TypeScript support, make it a powerful tool for modern asynchronous programming needs.
|
## Contribution
|
||||||
|
|
||||||
Explore the full range of features and feel free to read through the source code to learn more about the implementation details. Happy coding!
|
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). :)
|
||||||
|
|
||||||
## License and Legal Information
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
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.
|
## Legal
|
||||||
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||||
**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.
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
### 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.
|
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import * as smartpromise from '../ts/index.js';
|
import * as smartpromise from '../ts/index.js';
|
||||||
|
|
||||||
tap.test('should return a Deferred for .defer()', async () => {
|
tap.test('should return a Deferred for .defer()', async () => {
|
||||||
@ -24,4 +24,4 @@ tap.test('should map callbacks', async () => {
|
|||||||
expect(result).toEqual(inputArray);
|
expect(result).toEqual(inputArray);
|
||||||
});
|
});
|
||||||
|
|
||||||
export default tap.start();
|
tap.start();
|
||||||
|
|||||||
@ -1,57 +1,53 @@
|
|||||||
import * as smartpromise from '../ts/index.js';
|
import * as smartpromise from '../ts/index.js';
|
||||||
import { tap, expect } from '@push.rocks/tapbundle';
|
|
||||||
|
|
||||||
tap.test('simple deferred should resolve with correct value', async () => {
|
|
||||||
const done = smartpromise.defer<string>();
|
|
||||||
let result: string | undefined;
|
|
||||||
|
|
||||||
|
// using Deferreds
|
||||||
|
// simple deferred;
|
||||||
|
const done = smartpromise.defer();
|
||||||
done.promise.then((stringArg) => {
|
done.promise.then((stringArg) => {
|
||||||
result = stringArg;
|
console.log(stringArg);
|
||||||
});
|
});
|
||||||
done.resolve('hello');
|
done.resolve('hello'); // whenever you are ready
|
||||||
|
|
||||||
await done.promise;
|
// using deferreds in async functions to cater callback style apis
|
||||||
expect(result).toEqual('hello');
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('deferred should work with async functions and track status/duration', async () => {
|
|
||||||
const myAsyncFunction = async (): Promise<string> => {
|
const myAsyncFunction = async (): Promise<string> => {
|
||||||
const done = smartpromise.defer<string>();
|
const done = smartpromise.defer<string>(); // returns your typical Deferred object
|
||||||
|
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
done.resolve('hi');
|
done.resolve('hi'); // will throw type error for other types than string as argument ;)
|
||||||
}, 100); // reduced timeout for testing
|
}, 6000);
|
||||||
|
|
||||||
expect(done.status).toEqual('pending');
|
console.log(done.status); // logs "pending";
|
||||||
await done.promise;
|
await done.promise;
|
||||||
expect(done.status).toEqual('fulfilled');
|
console.log(done.status); // logs "fullfilled"
|
||||||
expect(done.duration).toBeGreaterThan(0);
|
console.log(done.duration); // outputs the duration in millisenconds
|
||||||
|
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
const result = await myAsyncFunction();
|
let myAsyncFunction2 = async () => {
|
||||||
expect(result).toEqual('hi');
|
let aString = await myAsyncFunction();
|
||||||
|
console.log(aString); // will log 'hi' to console
|
||||||
|
};
|
||||||
|
|
||||||
|
myAsyncFunction2();
|
||||||
|
|
||||||
|
// Resolved and Rejected promises
|
||||||
|
// ------------------------------------------------
|
||||||
|
smartpromise.resolvedPromise(`I'll get logged to console soon`).then((x) => {
|
||||||
|
console.log(x);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('resolvedPromise should resolve immediately with correct value', async () => {
|
smartpromise
|
||||||
const message = `I'll get logged to console soon`;
|
.rejectedPromise(`what a lovely error message`)
|
||||||
const result = await smartpromise.resolvedPromise(message);
|
.then(
|
||||||
expect(result).toEqual(message);
|
() => {
|
||||||
|
console.log('This never makes it to console');
|
||||||
|
} /*, alternatively put a reject function here */
|
||||||
|
)
|
||||||
|
.catch((err) => {
|
||||||
|
console.log(err);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('rejectedPromise should reject with correct error message', async () => {
|
import { tap, expect } from '@pushrocks/tapbundle';
|
||||||
const errorMessage = 'what a lovely error message';
|
|
||||||
let caught = false;
|
|
||||||
|
|
||||||
try {
|
tap.test('runs through', async () => {});
|
||||||
await smartpromise.rejectedPromise(errorMessage);
|
tap.start();
|
||||||
} catch (err) {
|
|
||||||
caught = true;
|
|
||||||
expect(err).toEqual(errorMessage);
|
|
||||||
}
|
|
||||||
|
|
||||||
expect(caught).toEqual(true);
|
|
||||||
});
|
|
||||||
|
|
||||||
export default tap.start();
|
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @push.rocks/commitinfo
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartpromise',
|
name: '@pushrocks/smartpromise',
|
||||||
version: '4.2.3',
|
version: '4.0.0',
|
||||||
description: 'A TypeScript library for managing promises and Deferred constructs, simplifying asynchronous programming.'
|
description: 'simple promises and Deferred constructs'
|
||||||
}
|
}
|
||||||
|
|||||||
19
ts/index.ts
19
ts/index.ts
@ -80,22 +80,3 @@ export const getFirstTrueOrFalse = async (promisesArg: Promise<boolean>[]) => {
|
|||||||
});
|
});
|
||||||
return done.promise;
|
return done.promise;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* Converts a Node.js-style callback-based function into a Promise.
|
|
||||||
* @param fn The function that expects a callback.
|
|
||||||
* @returns A Promise that resolves with the result of the function or rejects with an error.
|
|
||||||
*/
|
|
||||||
export const fromCallback = <T>(
|
|
||||||
fn: (callback: (err: NodeJS.ErrnoException | null, result?: T) => void) => void
|
|
||||||
): Promise<T> => {
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
fn((err, result) => {
|
|
||||||
if (err) {
|
|
||||||
reject(err); // Reject the promise with the error
|
|
||||||
} else {
|
|
||||||
resolve(result as T); // Resolve the promise with the result
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|||||||
@ -15,12 +15,6 @@ export class CumulativeDeferred {
|
|||||||
}, 0);
|
}, 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
public subDefer() {
|
|
||||||
const done = defer();
|
|
||||||
this.addPromise(done.promise);
|
|
||||||
return done;
|
|
||||||
}
|
|
||||||
|
|
||||||
public addPromise(promiseArg: Promise<any>) {
|
public addPromise(promiseArg: Promise<any>) {
|
||||||
this.accumulatedPromises.push(promiseArg);
|
this.accumulatedPromises.push(promiseArg);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -13,13 +13,6 @@ export class Deferred<T> {
|
|||||||
public resolve: IResolve<T>;
|
public resolve: IResolve<T>;
|
||||||
public reject: IReject;
|
public reject: IReject;
|
||||||
public status: TDeferredStatus;
|
public status: TDeferredStatus;
|
||||||
public claimed = false;
|
|
||||||
public claim() {
|
|
||||||
if (this.claimed) {
|
|
||||||
throw new Error('Deferred already claimed');
|
|
||||||
}
|
|
||||||
this.claimed = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
public startedAt: number;
|
public startedAt: number;
|
||||||
public stoppedAt: number;
|
public stoppedAt: number;
|
||||||
|
|||||||
@ -3,12 +3,8 @@
|
|||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
"useDefineForClassFields": false,
|
"useDefineForClassFields": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "NodeNext",
|
"module": "ES2022",
|
||||||
"moduleResolution": "NodeNext",
|
"moduleResolution": "nodenext",
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true
|
||||||
"verbatimModuleSyntax": true
|
}
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user