Reusable asynchronous signals for JavaScript/TypeScript applications.
pnpm add asyncsignal
// or
npm install asyncsignal
// or
yarn add asyncsignal- 🚦 Reusable Signals: Create async signals that can be reused after reset
- 🔒 Constraint Support: Add conditions that must be met before signal resolution
- ⏱️ Timeout Control: Set timeout for signal resolution with customizable behavior
- 🎯 Signal States: Track signal states (pending, resolved, rejected)
- 🎮 Signal Management: Manage multiple signals with AsyncSignalManager
- 🔄 Reset Capability: Reset signals to their initial state for reuse
- 💪 TypeScript Support: Full TypeScript support with type definitions
import { asyncSignal } from 'asyncsignal';
// Create a basic signal
const signal = asyncSignal();
// Wait for signal resolution
await signal();
// Resolve the signal
signal.resolve('success');
// Reject the signal
signal.reject(new Error('something went wrong'));
// Reset the signal for reuse
signal.reset();// Signal will only resolve when the constraint function returns true
const signal = asyncSignal(() => someCondition === true);
// Attempting to resolve when constraint is not met will be ignored
signal.resolve(); // Will only resolve if someCondition === true// Create signal with default timeout
const signal = asyncSignal(undefined, { timeout: 1000 });
// Wait with timeout and default value
await signal(2000); // Will resolve after 2 seconds
// Wait with timeout and error
await signal(2000, new Error('Timeout occurred')); // Will reject with error after 2 secondsconst signal = asyncSignal();
console.log(signal.isPending()); // true after creation
console.log(signal.isResolved()); // true after resolution
console.log(signal.isRejected()); // true after rejectionimport { asyncSignal, AsyncSignalAbort } from 'asyncsignal';
// Handle signal destruction
const signal = asyncSignal();
try {
await signal();
} catch (error) {
if (error instanceof AsyncSignalAbort) {
console.log('Signal was destroyed');
}
}- Signal states are mutually exclusive (pending, resolved, rejected)
- Calling
resolve()orreject()on a non-pending signal will be ignored - Calling
resolve()when the constraint function returns false will be silently ignored - The
destroy()method will reject pending signals with AsyncSignalAbort error
import { AsyncSignalManager } from 'asyncsignal';
// Create a signal manager with default timeout
const manage
7974
r = new AsyncSignalManager({ timeout: 5000 });
// Create multiple signals
const signal1 = manager.create();
const signal2 = manager.create(() => someCondition);
// Resolve all signals with optional value
manager.resolve('success');
// Reject all signals
manager.reject(new Error('batch operation failed'));
// Reset all signals for reuse
manager.reset();
// Destroy specific signals
manager.destroy(signal1.id);
// Destroy multiple signals
manager.destroy([signal1.id, signal2.id]);
// Destroy all signals
manager.destroy();