Guide Introduction

Welcome to the Nexus Orchestrator documentation. This guide will take you from beginner to expert, explaining every feature with real-world analogies, diagrams, and battle-tested code examples.

What You'll Learn

This guide is structured in three parts:

1. Core Concepts

Learn the foundational patterns that make Nexus powerful:

• RPC Pattern: How to make request/reply work seamlessly
• Priority Lanes: Preventing UI freezes with execution scheduling
• Cursors & State: Synchronous access to event data
• Wildcard Patterns: Subscribe to multiple events with pattern matching
• Event Replay: Late subscribers catch up with historical events
• Subscription Lifecycle: Proper cleanup and memory management

2. Resilience Engineering

Build bulletproof applications:

• Circuit Breakers: Automatic retries and fallback handling
• Chaos Monkey: Test failure scenarios in development

3. Next-Generation Features

Leverage cutting-edge capabilities:

• AI Prediction: Learn user patterns and prefetch intelligently
• Teleportation: Bridge client and server effortlessly
• Pipes: Transform data with middleware operators

Prerequisites

You should have:

• Basic TypeScript/JavaScript knowledge
• Understanding of async/await and Promises
• Familiarity with event-driven architecture (not required but helpful)

Navigation Tips

Each page in this guide follows the same structure:

1. Analogy: A real-world metaphor to build intuition
2. Problem Statement: Why existing solutions fall short
3. Solution: How Nexus solves it
4. Diagrams: Visual explanation with Mermaid charts
5. Code Examples: Basic → Real-World → Edge Cases

Let's begin with Getting Started →