fix(ci): Remove .gitlab-ci.yml and update dependencies and metadata
This commit is contained in:
@@ -1,5 +1,6 @@
|
||||
# @push.rocks/smartpromise
|
||||
simple promises and Deferred constructs
|
||||
|
||||
A library for simple promises and Deferred constructs with TypeScript support.
|
||||
|
||||
## Install
|
||||
|
||||
@@ -86,7 +87,7 @@ rejectedPromise('immediately rejected').catch(console.error);
|
||||
|
||||
#### 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.
|
||||
`@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
|
||||
|
||||
@@ -132,9 +133,163 @@ async function processData(items: string[]): Promise<string[]> {
|
||||
processData(['hello', 'world']).then(console.log);
|
||||
```
|
||||
|
||||
### Conclusion
|
||||
### Handling Complex Promise Scenarios
|
||||
|
||||
`@push.rocks/smartpromise` offers a refined and accessible approach to handling promises and asynchronous operations in TypeScript. Whether you're dealing with individual promises, a group of asynchronous tasks, or integrating callback-based APIs into your promise flows, this library provides the necessary tools to make your code more readable and easier to manage. With straightforward utility functions and TypeScript support, it enhances the native Promise API, making it an essential tool for modern TypeScript development.
|
||||
#### 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 () => {
|
||||
const longRunningPromise = new Promise((resolve) => setTimeout(resolve, 2000));
|
||||
try {
|
||||
await smartpromise.timeoutWrap(longRunningPromise, 1000);
|
||||
} catch (err) {
|
||||
expect(err.message).toEqual('timeout');
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('should map async function to an array', async () => {
|
||||
const inputArray = ['a', 'b'];
|
||||
const result = await smartpromise.map(inputArray, async (item) => item.toUpperCase());
|
||||
expect(result).toEqual(['A', 'B']);
|
||||
});
|
||||
|
||||
tap.start();
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
Explore the full range of features and feel free to read through the source code to learn more about the implementation details. Happy coding!
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
|
||||
Reference in New Issue
Block a user