Class: ChannelResource

Defined in: src/resources/channel.ts:24

Channel 리소스. https://chzzk.gitbook.io/chzzk/chzzk-api/channel

Constructors

Constructor

new ChannelResource(deps): ChannelResource;

Defined in: src/resources/channel.ts:25

Parameters

deps

ResourceDeps

Returns

ChannelResource

Methods

followers()

followers(params?): Promise<{
[key: string]: unknown;
  data: object[];
  page?: number;
  totalCount?: number;
  totalPages?: number;
}>;

Defined in: src/resources/channel.ts:72

채널 팔로워 조회(단일 페이지) — GET /open/v1/channels/followers 〔유저 토큰 · Scope: 채널 팔로워 조회〕

응답의 page/totalCount/totalPages는 문서에 없지만 실측으로 확인된 메타.

Parameters

params?

PageParams = {}

Returns

Promise<{ [key: string]: unknown; data: object[]; page?: number; totalCount?: number; totalPages?: number; }>

---

get()

get(channelIds): Promise<object[]>;

Defined in: src/resources/channel.ts:31

채널 정보 조회 — GET /open/v1/channels 〔Client 인증〕

Parameters

channelIds

readonly string[]

최대 20개. 일치하는 채널이 없으면 해당 항목은 결과에서 빠진다.

Returns

Promise<object[]>

---

iterateFollowers()

iterateFollowers(params?): AsyncGenerator<{
[key: string]: unknown;
  channelId: string;
  channelName: string;
  createdDate: string;
}, void>;

Defined in: src/resources/channel.ts:91

팔로워 전체 자동 순회. totalPages(실측 메타) 또는 빈 페이지에서 종료.

Parameters

params?

Pick<PageParams, "size"> = {}

Returns

AsyncGenerator<{ [key: string]: unknown; channelId: string; channelName: string; createdDate: string; }, void>

---

iterateSubscribers()

iterateSubscribers(params?): AsyncGenerator<{
[key: string]: unknown;
  channelId: string;
  channelName: string;
  createdDate: string;
  month: number;
  tierNo: number;
}, void>;

Defined in: src/resources/channel.ts:128

구독자 전체 자동 순회. totalPages(실측 메타) 또는 빈 페이지에서 종료.

Parameters

params?

Pick<PageParams, "size"> & object = {}

Returns

AsyncGenerator<{ [key: string]: unknown; channelId: string; channelName: string; createdDate: string; month: number; tierNo: number; }, void>

---

streamingRoles()

streamingRoles(): Promise<object[]>;

Defined in: src/resources/channel.ts:50

채널 관리자 조회 — GET /open/v1/channels/streaming-roles 〔유저 토큰 · Scope: 채널 관리자 조회〕

채널 소유자 본인도 목록에 포함되며, 이때 userRole은 실측상 STREAMER다 (문서의 STREAMING_CHANNEL_OWNER와 다름 — docs/api-notes.md #25).

Returns

Promise<object[]>

---

subscribers()

subscribers(params?): Promise<{
[key: string]: unknown;
  data: object[];
  page?: number;
  totalCount?: number;
  totalPages?: number;
}>;

Defined in: src/resources/channel.ts:109

채널 구독자 조회(단일 페이지) — GET /open/v1/channels/subscribers 〔유저 토큰 · Scope: 채널 구독자 조회〕

Parameters

params?

PageParams & object = {}

Returns

Promise<{ [key: string]: unknown; data: object[]; page?: number; totalCount?: number; totalPages?: number; }>