📚 2 min read

Getting Started

Overview

A comprehensive collection of async JavaScript patterns and implementations, with TypeScript support and best practices.

Installation

git clone https://github.com/Underwood-Inc/async-mastery.git
cd async-mastery
npm install

Quick Start

import { withRetry } from './patterns/auto-retry';
import { Memoizer } from './patterns/memoization';

// Example: Fetch data with retry and caching
const api = new Memoizer({
  maxAge: 60000,
  maxSize: 100,
});

const fetchData = async (id: string) => {
  return api.memoize(
    () =>
      withRetry(
        async () => {
          const response = await fetch(`/api/data/${id}`);
          return response.json();
        },
        { maxAttempts: 3 }
      ),
    id
  );
};

Pattern Categories

Promise Implementations

• Custom Promise - Build your own Promise from scratch
• Promise.all() - Parallel execution with all promises
• Promise.any() - Race to first success
• Promise.race() - Race to first completion
• Promise.allSettled() - Wait for all completions
• Promise.finally() - Guaranteed execution
• Promise.resolve/reject - Static promise creation

Task Management

• Tasks in Series - Sequential execution
• Tasks in Parallel - Concurrent execution
• Tasks Racing - Competitive execution

Timer Control

• Custom setTimeout - Enhanced timeout implementation
• Custom setInterval - Enhanced interval implementation
• Clear All Timers - Timer management

Rate Control

• Auto-Retry - Automatic failure recovery
• Batch Throttling - Group API calls
• Debouncing - Delay until settled
• Throttling - Rate limiting
• Memoization - Result caching

Best Practices

Code Quality

• TypeScript strict mode compatibility
• Comprehensive error handling
• Performance monitoring
• Extensive testing
• Environment-specific optimizations

Pattern Selection Guide

• When to use each pattern
• Pattern combinations
• Common pitfalls
• Performance considerations
• Error handling strategies

Contributing

See Contributing Guide for guidelines on contributing to this project.

License

This project is licensed under the OpenRAIL License. This license is specifically designed for AI-assisted content and promotes responsible AI development while maintaining open-source principles. See the LICENSE file for details.

AI Content Disclosure

This project contains content generated with AI assistance. Contributors should:

• Document AI tool usage in commits
• Note potential limitations or biases
• Review and verify AI-generated content thoroughly
• Maintain transparency about AI involvement