Class: ChzzkRealtime
Defined in: src/realtime/stream.ts:63
Consumers 계층 — 정규화 이벤트의 읽기 전용 팬아웃.
단일 업스트림(SessionTransport) 위에 여러 독립 다운스트림이 붙는다:
- 이벤트 에미터:
on('chat', ...)등 — 리스너 예외는 서로 격리 - AsyncIterable:
for await (const e of realtime.events())— 소비자마다 독립 버퍼를 가져 하나가 느려도 다른 소비자·연결에 영향 없음
SDK의 책임은 여기까지다. 필터링·명령 파싱·모더레이션 판단 같은 가공은 소비자가 스트림 위에서 직접 한다 (examples/ 참고) — 가로채기 계층 없음.
Extends
TypedEmitter<RealtimeEvents>
Constructors
Constructor
new ChzzkRealtime(options): ChzzkRealtime;Defined in: src/realtime/stream.ts:69
Parameters
options
logger?
transport
Returns
ChzzkRealtime
Overrides
Accessors
session
Get Signature
get session(): SessionTransport;Defined in: src/realtime/stream.ts:97
하부 Transport (고급 사용 — sessionKey, 동적 구독 등)
Returns
Methods
chats()
chats(options?): AsyncIterableIterator<ChatMessage>;Defined in: src/realtime/stream.ts:181
채팅만 골라낸 AsyncIterable (편의 헬퍼 — 가공이 아닌 타입 필터)
Parameters
options?
Returns
AsyncIterableIterator<ChatMessage>
close()
close(): void;Defined in: src/realtime/stream.ts:107
정상 종료 — 연결을 닫고 모든 AsyncIterable 소비자를 종료한다
Returns
void
donations()
donations(options?): AsyncIterableIterator<Donation>;Defined in: src/realtime/stream.ts:188
후원만 골라낸 AsyncIterable
Parameters
options?
Returns
AsyncIterableIterator<Donation>
events()
events(options?): AsyncIterableIterator<NormalizedEvent>;Defined in: src/realtime/stream.ts:128
모든 정규화 이벤트의 AsyncIterable. 소비자마다 독립 버퍼 — 추가/제거가 연결이나 다른 소비자에 영향을 주지 않는다.
Parameters
options?
Returns
AsyncIterableIterator<NormalizedEvent>
off()
off<K>(event, listener): void;Defined in: src/realtime/emitter.ts:20
Type Parameters
K
K extends keyof RealtimeEvents
Parameters
event
K
listener
(...args) => void
Returns
void
Inherited from
on()
on<K>(event, listener): () => void;Defined in: src/realtime/emitter.ts:10
Type Parameters
K
K extends keyof RealtimeEvents
Parameters
event
K
listener
(...args) => void
Returns
() => void
Inherited from
start()
start(): Promise<void>;Defined in: src/realtime/stream.ts:102
연결 시작 (최초 연결+구독 완료까지 대기)
Returns
Promise<void>
subscribe()
subscribe(eventType): Promise<void>;Defined in: src/realtime/stream.ts:115
이벤트 구독 추가 (연결 중 즉시 반영 + 재연결 시 자동 재구독)
Parameters
eventType
"chat" | "donation" | "subscription"
Returns
Promise<void>
subscriptions()
subscriptions(options?): AsyncIterableIterator<SubscriptionEvent>;Defined in: src/realtime/stream.ts:195
구독(멤버십)만 골라낸 AsyncIterable
Parameters
options?
Returns
AsyncIterableIterator<SubscriptionEvent>
unsubscribe()
unsubscribe(eventType): Promise<void>;Defined in: src/realtime/stream.ts:120
이벤트 구독 해지
Parameters
eventType
"chat" | "donation" | "subscription"
Returns
Promise<void>