@d2n0s4ur/chzzk-chat
Version:
chzzk-chat: node.js 개발자를 위한 chzzk 채팅 & 후원 비공식 라이브러리
119 lines (88 loc) • 2.95 kB
Markdown
# Chzzk-Chat library
[](https://www.npmjs.com/package/@d2n0s4ur/chzzk-chat)
[](https://www.npmjs.com/package/@d2n0s4ur/chzzk-chat)
[](https://github.com/d2n0s4ur/chzzk-chat)
[](https://www.npmjs.com/package/@d2n0s4ur/chzzk-chat)
<img alt="chzzk_logo" src="./img/chzzk_logo.svg" style="width: 40%">
Javascript를 통해 치지직 채팅을 크롤링하는 코드입니다.
# Important Update
- 각 Handler의 인자가 변경되었습니다.(중괄호로 감쌈) 이전 버전과 호환되지 않습니다.
- 개발자 여러분들은 바뀐 핸들러 코드를 확인하고 소스코드를 수정해주세요.
# Install
## Node
### NPM
```bash
$ npm install @d2n0s4ur/chzzk-chat
```
### Yarn
```bash
$ yarn add @d2n0s4ur/chzzk-chat
```
## Usage
```typescript
import { ChzzkChat } from "@d2n0s4ur/chzzk-chat";
const chzzkChat = new ChzzkChat("YOUR_CHZZK_USER_HASH");
// ex) ChzzkChat('dfffd9591264f43f4cbe3e2e3252c35c')
```
### 1. Add message Handler
```typescript
const messageHandler: messageHandler = ({
badges: string[],
nick: string,
message: string
}) => {
console.log(`${nick}: ${message}`);
};
chzzkChat.addMessageHandler(messageHandler);
```
### 2. Add donation Handler
```typescript
const donationHandler: donationHandler = ({
badges: string[],
nick: string,
message: string,
isAnonymous: boolean,
amount: number
}) => {
if (!isAnonymous) {
console.log(`${nick}님이 ${amount}원을 후원했습니다: ${message}`);
} else {
console.log(`익명의 후원자가 ${amount}원을 후원했습니다: ${message}`);
}
};
chzzkChat.addDonationHandler(donationHandler);
```
### 3. Add subscription Handler
```typescript
const subscriptionHandler: subscriptionHandler = ({
badges: string[],
nick: string,
message: string,
month: number,
tierName: string,
tierNo: number
}) => {
console.log(
`${nick}님이 ${month}개월 ${tierName}를 구독했습니다: ${message}`
);
};
chzzkChat.addSubscriptionHandler(subscriptionHandler);
```
### 4. get Emoji Url from EmojiID
```typescript
const emojiRegex = /:\w+:/g;
const emojiMatches = message.match(emojiRegex);
if (emojiMatches) {
emojiMatches.forEach((emoji) => {
const emojiName = emoji.slice(1, -1);
const emojiUrl = chzzkChat.getEmojiUrl(emojiName);
console.log(emojiUrl);
});
}
```
사용이 끝난 후, `chzzkChat.close()`를 호출하여 웹소켓을 닫아주세요.
After using the library, please call `chzzkChat.close()` to close the websocket.
```typescript
chzzkChat.close();
```