日本語 Guide

@gurezo/web-serial-rxjs の利用方法を説明する手書き Markdown Guide です。公開 API の型・引数・戻り値の網羅的な仕様は英語 TypeDoc API Reference を参照してください。

canonical なドキュメント構成は ARCHITECTURE.ja.md を参照してください。

Getting Started（推奨する読み順）

概要 — SerialSession の公開面、state$ / errors$ の位置付け、最小サンプル
クイックスタート — インストール、接続、受信・送信、切断・破棄、エラーハンドリング
高度な使用方法 — 行フレーミング、擬似リクエスト／レスポンス、リカバリ
API の概念と設計メモ — オプション表、SerialError、型の補足（TypeDoc の代替ではありません）

既存コードから移行する場合:

v2 → v3 マイグレーション — state$ discriminated union、SerialSessionStatus、context.cause
v1 → v2 マイグレーション — 削除された v1 API の対応表

ドキュメント一覧

ドキュメント	用途
概要	公開面の早見表、機能概要、最小サンプル
クイックスタート	インストールから切断までの基本フロー
高度な使用方法	応用パターンと RxJS レシピ
API の概念と設計メモ	オプション・エラーコード・型の表形式補足
v2 → v3 マイグレーション	v3 canonical API への移行手順
v1 → v2 マイグレーション	v1 廃止 API の置き換え
Phase 5（アーカイブ）	旧 v1 ドキュメントの参照用

関連リンク

モノレポ README.ja.md — サンプルアプリ索引、貢献、ブラウザサポート
English Guide — English Guide 索引
ドキュメントトップ — ../../index.html
英語 TypeDoc API Reference — ../../api/modules.html
親 Issue — #453（ドキュメント構成整備）

v3 canonical API の要点

state$ — 接続ライフサイクルの canonical source。state.status と SerialSessionStatus で分岐し、connected 時は state.portInfo を利用する
errors$ — fatal / non-fatal エラーの canonical event channel。SerialError.is(SerialErrorCode.*) で分岐する
非推奨 convenience — isConnected$、portInfo$、getPortInfo() は v3.x で残存するが、新規コードでは state$ narrowing を優先する