buzzk 1.1.0 → 1.2.0

package/README.md

@@ -17,6 +17,10 @@
 
 ##  업데이트 내역
 
+ - 자동완성 기능 지원
+
+>
+
  - 팔로우 / 언팔로우 기능 추가
  - live.getLiveDetail의 Return 값에 chatLimit 추가 (팔로우 대상 채팅 등...)
  - 폴링 함수 추가 (chatID 변경 감지)

package/lib/channel.js

@@ -11,6 +11,24 @@ class chzzkChannel {
     }
 }
 
+/**
+ * @typedef {Object.<number, chzzkChannel>} chzzkChannels
+ */
+
+/**
+ * @typedef {Object} chzzkChannel
+ * @property {string} channelID
+ * @property {string} name
+ * @property {string} description
+ * @property {string} follower
+ * @property {string} imageURL
+ * @property {string} isLive
+ */
+
+/**
+ * @param {string} keyword
+ * @returns {Promise<chzzkChannels>}
+ */
 async function getChannel (keyword) {
     return new Promise(async (resolve, reject) => {
 
@@ -32,6 +50,10 @@ async function getChannel (keyword) {
     });
 }
 
+/**
+ * @param {string} channelID
+ * @returns {Promise<boolean>}
+ */
 async function followChannel (channelID) {
     return new Promise(async (resolve, reject) => {
 
@@ -42,6 +64,10 @@ async function followChannel (channelID) {
     });
 }
 
+/**
+ * @param {string} channelID
+ * @returns {Promise<boolean>}
+ */
 async function unFollowChannel (channelID) {
     return new Promise(async (resolve, reject) => {
 

package/lib/chat.js

@@ -19,6 +19,9 @@ class chzzkChat {
     #pollingStatus = false;
     //Private
 
+    /**
+     * @returns {Promise<boolean>}
+     */
     connect() {
         return new Promise(async (resolve, reject) => {
             if (this.#ws) return resolve(null);
@@ -105,6 +108,10 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @param {string} message 
+     * @returns {Promise<boolean>}
+     */
     send(message) {
         return new Promise(async (resolve, reject) => {
             if (!this.#ws) return resolve(null);
@@ -143,6 +150,27 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @typedef {Object.<number, chzzkMessage>} chzzkMessages
+     */
+
+    /**
+     * @typedef {Object} chzzkMessage
+     * @property {chzzkMessageAuthor} author
+     * @property {string} message
+     * @property {number} time
+     */
+
+    /**
+     * @typedef {Object} chzzkMessageAuthor
+     * @property {string} id
+     * @property {string} name
+     * @property {string} imageURL
+     */
+
+    /**
+     * @param {function(chzzkMessages)} callback
+     */
     onMessage(callback) {
         if (!this.#ws) return callback(null);
 
@@ -174,6 +202,10 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @param {?number} size
+     * @return {Promise<chzzkMessages>}
+     */
     getRecentChat(size) {
         return new Promise(async (resolve, reject) => {
             if (!this.#ws) return resolve(null);
@@ -221,6 +253,9 @@ class chzzkChat {
         });
     }
 
+    /**
+     * @returns {Promise<boolean>}
+     */
     async disconnect() {
         return new Promise(async (resolve, reject) => {
             if (!this.#ws) return resolve(null);

package/lib/live.js

@@ -1,5 +1,30 @@
 const { reqChzzk } = require("./tool.js");
 
+/**
+ * @typedef {Object} chzzkLiveDetail
+ * @property {string} channelID
+ * @property {Object} channel
+ * @property {string} chatID
+ * @property {string} chatLimit
+ * @property {userCount} userCount
+ * @property {string} title
+ * @property {string} startOn
+ * @property {string} closeOn
+ * @property {string} status
+ * @property {Object} polling
+ * 
+ */
+
+/**
+ * @typedef {Object} userCount
+ * @property {number} now
+ * @property {number} total
+ */
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<chzzkLiveDetail>}
+ */
 async function getLiveDetail (channelID) {
     return new Promise(async (resolve, reject) => {
 
@@ -25,6 +50,21 @@ async function getLiveDetail (channelID) {
     });
 }
 
+/**
+ * @typedef {Object} chzzkLiveStatus
+ * @property {string} channelID
+ * @property {string} chatID
+ * @property {userCount} userCount
+ * @property {string} title
+ * @property {string} status
+ * @property {Object} polling
+ * 
+ */
+
+/**
+ * @param {string} channelID
+ * @returns {Promise<chzzkLiveStatus>}
+ */
 async function getLiveStatus (channelID) {
     return new Promise(async (resolve, reject) => {
 

package/lib/val.js

@@ -6,6 +6,11 @@ let NID = {
     SES: null
 }
 
+
+/**
+ * @param {string} NID_AUT
+ * @param {string} NID_SES
+ */
 function login (NID_AUT, NID_SES) {
     NID.AUT = NID_AUT;
     NID.SES = NID_SES;

package/lib/vm.js

@@ -11,7 +11,7 @@ async function check () {
     remotePkg = String(remotePkg.version).split(".");
 
     for (let v in remotePkg) {
-        if (parseInt(remotePkg[v]) > parseInt(localPkg[v])) return console.log("[BUZZK] 새로운 버전을 찾았습니다! ( 현재 버전 : " + localPkg.join(".") + " / 새로운 버전 : " + remotePkg.join(".") + " )");
+        if (parseInt(remotePkg[v]) > parseInt(localPkg[v])) return console.log("[BUZZK] 새로운 버전을 찾았습니다! ( npm install buzzk@" + remotePkg.join(".") + " )");
     }
 }
 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "buzzk",
   "displayName": "BUZZK",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "뿌지직 (BUZZK) - 치지직(CHZZK) 챗봇을 더욱 쉽게 개발할 수 있도록 돕는 비공식 라이브러리.",
   "main": "lib/index.js",
+  "type": "commonjs",
   "directories": {
     "lib": "lib"
   },