English Guide

Hand-written Markdown Guide for using @gurezo/web-serial-rxjs. For exhaustive public API types, parameters, and return values, see the English TypeDoc API Reference.

The canonical documentation layout is defined in ARCHITECTURE.md.

Getting Started (recommended reading order)

1. Overview — SerialSession public surface, role of state$ / errors$, minimal sample
2. Quick Start — installation, connect, receive/send, disconnect/dispose, error handling
3. Advanced Usage — line framing, request/response-style flows, recovery
4. API concepts and design notes — options tables, SerialError, type supplements (not a TypeDoc substitute)

When migrating existing code:

• v2 → v3 Migration — state$ discriminated union, SerialSessionStatus, context.cause
• v1 → v2 Migration — mapping for removed v1 APIs

Documentation index

Related links

• Monorepo README.md — example apps index, contributing, browser support
• 日本語 Guide — 日本語 Guide index
• Documentation home — ../index.html
• English TypeDoc API Reference — modules.html
• Parent issue — #453 (documentation structure)

v3 canonical API highlights

• state$ — canonical lifecycle source. Branch on state.status with SerialSessionStatus; use state.portInfo when connected
• errors$ — canonical fatal / non-fatal error event channel. Branch with SerialError.is(SerialErrorCode.*)
• Deprecated convenience — isConnected$, portInfo$, getPortInfo() remain in v3.x; prefer state$ narrowing in new code