Class: ChzzkOpenClient

Defined in: src/client.ts:47

CHZZK Open API 클라이언트 (엔트리포인트).

const client = new ChzzkOpenClient({ clientId, clientSecret });
client.getAuthorizationUrl({ redirectUri, state }); // 유저를 이 URL로 리다이렉트
await client.auth.login({ code, state });           // 콜백에서 토큰 교환
const me = await client.users.me();

Constructors

Constructor

new ChzzkOpenClient(options): ChzzkOpenClient;

Defined in: src/client.ts:64

Parameters

options

ChzzkOpenClientOptions

Returns

ChzzkOpenClient

Properties

auth

readonly auth: TokenManager;

Defined in: src/client.ts:50

유저 토큰 수명 관리 (login/setTokens/getAccessToken/revoke)

---

categories

readonly categories: CategoryResource;

Defined in: src/client.ts:53

---

channels

readonly channels: ChannelResource;

Defined in: src/client.ts:52

---

chats

readonly chats: ChatResource;

Defined in: src/client.ts:55

---

drops

readonly drops: DropsResource;

Defined in: src/client.ts:56

---

http

readonly http: HttpClient;

Defined in: src/client.ts:48

---

lives

readonly lives: LiveResource;

Defined in: src/client.ts:54

---

restrictions

readonly restrictions: RestrictionResource;

Defined in: src/client.ts:57

---

sessions

readonly sessions: SessionResource;

Defined in: src/client.ts:58

---

users

readonly users: UserResource;

Defined in: src/client.ts:51

Methods

createRealtime()

createRealtime(options): ChzzkRealtime;

Defined in: src/client.ts:119

실시간 정규화 이벤트 스트림 생성.

단일 업스트림 연결 위에 여러 소비자(에미터/AsyncIterable)가 붙는다. start()로 연결하고 close()로 종료한다. 자세한 사용 패턴은 examples/ 참고.

const realtime = client.createRealtime({ auth: 'client', subscriptions: ['chat'] });
realtime.on('chat', (chat) => console.log(chat.nickname, chat.content));
await realtime.start();

Parameters

options

auth

"client" | "user"

connectedTimeoutMs?

number

preferWebSocket?

boolean

reconnect?

SessionTransportReconnectOptions

subscriptions?

readonly ("chat" | "donation" | "subscription")[]

Returns

ChzzkRealtime

---

getAuthorizationUrl()

getAuthorizationUrl(params): string;

Defined in: src/client.ts:103

인가 코드 요청 URL 생성 — 유저를 이 URL로 리다이렉트한다.

Parameters

params

redirectUri

string

state

string

Returns

string