tiaoom 0.0.3 → 0.0.6

package/src/index.d.cts

@@ -2,54 +2,129 @@
 import EventEmitter$1, { EventEmitter } from "events";
 
 //#region lib/events/base.d.ts
+/**
+ * 基础事件定义
+ */
 interface BaseEvents {
+  /**
+   * 服务初始化回调
+   */
   ready: () => void;
+  /**
+   * 服务关闭回调
+   */
   close: () => void;
+  /**
+   * 错误回调
+   * @param {Error} error 错误信息
+   */
   error: (error: Error) => void;
 }
 //#endregion
 //#region lib/events/player.d.ts
+/**
+ * 玩家事件定义
+ */
 interface PlayerEvents extends BaseEvents {
   /**
    * 加入房间
+   * @param {Room} room 房间信息
+   * @param {Player} player 玩家信息
    **/
   join: (room: Room, player: Player) => void;
   /**
    * 离开房间
+   * @param {Room} room 房间信息
+   * @param {Player} player 玩家信息
    **/
   leave: (room: Room, player: Player) => void;
   /**
    * 玩家状态变化
+   * @param {PlayerStatus} status 玩家状态
    **/
   status: (status: PlayerStatus) => void;
   /**
    * 玩家命令
+   * @param {MessagePackage} message 命令内容
    */
   command: (message: MessagePackage) => void;
   /**
    * 玩家私信
+   * @param {string} data 消息内容
+   * @param {Player} [sender] 发送者信息（可选）
    **/
   message: (data: string, sender?: Player) => void;
 }
 //#endregion
 //#region lib/models/player.d.ts
+/**
+ * 玩家选项接口
+ */
 interface PlayerOptions {
+  /**
+   * 玩家ID
+   */
   id: string;
+  /**
+   * 玩家名称
+   */
   name: string;
+  /**
+   * 玩家属性
+   */
   attributes?: any;
+  /**
+   * 发送者函数
+   */
   sender?: (type: string, ...message: any) => void;
 }
+/**
+ * 玩家状态枚举
+ */
 declare enum PlayerStatus {
+  /**
+   * 已准备
+   */
   ready = "ready",
+  /**
+   * 未准备
+   */
   unready = "unready",
+  /**
+   * 在线
+   */
   online = "online",
+  /**
+   * 游戏中
+   */
   playing = "playing",
 }
+/**
+ * 玩家接口
+ */
 interface IPlayer extends PlayerOptions {
+  /**
+   * 玩家状态
+   */
   status: PlayerStatus;
 }
+/**
+ * 玩家
+ */
 declare class Player extends EventEmitter$1 implements IPlayer {
+  /**
+   * 监听玩家事件
+   * @param event 事件名，具体见 PlayEvents
+   * @param listener 监听器
+   * @returns this
+   */
   on<K extends keyof PlayerEvents>(event: K, listener: PlayerEvents[K]): this;
+  /**
+   * 触发玩家事件
+   * @param event 事件名，具体见 PlayEvents
+   * @param args 参数
+   * @returns 是否有监听器被触发
+   */
   emit<K extends keyof PlayerEvents>(event: K, ...args: Parameters<PlayerEvents[K]>): boolean;
   id: string;
   name: string;
@@ -69,10 +144,18 @@ declare class Player extends EventEmitter$1 implements IPlayer {
     status: PlayerStatus;
   };
   toString(): string;
+  /**
+   * 设置发送者函数
+   * @param {(type: string, ...message: any) => void} sender 发送者函数
+   * @returns this
+   */
   setSender(sender: (type: string, ...message: any) => void): this;
 }
 //#endregion
 //#region lib/models/message.d.ts
+/**
+ * 消息包类型枚举
+ */
 declare enum MessageTypes {
   RoomList = "room.list",
   RoomCreate = "room.create",
@@ -93,74 +176,126 @@ declare enum MessageTypes {
   PlayerUnready = "player.unready",
   PlayerCommand = "player.command",
 }
+/**
+ * 消息包接口
+ */
 interface MessagePackage {
+  /**
+   * 消息类型
+   */
   type: MessageTypes | string;
+  /**
+   * 消息数据
+   */
   data?: PlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
+  /**
+   * 消息发送者
+   */
   sender?: IPlayer | IRoom | IRoomPlayer;
 }
+/**
+ * 消息通信接口
+ */
 interface Message extends EventEmitter$1 {
+  /**
+   * 监听消息事件
+   * @param event 事件名，具体见 MessageEvents
+   * @param listener 监听器
+   */
   on<K extends keyof MessageEvents>(event: K, listener: MessageEvents[K]): this;
+  /**
+   * 触发消息事件
+   * @param event 事件名，具体见 MessageEvents
+   * @param args 参数
+   */
   emit<K extends keyof MessageEvents>(event: K, ...args: Parameters<MessageEvents[K]>): boolean;
+  /**
+   * 关闭连接
+   */
   close(): void;
+  /**
+   * 发送消息包
+   * @param message 消息包
+   */
   send(message: MessagePackage): void;
 }
 //#endregion
 //#region lib/events/message.d.ts
+/**
+ * 消息事件定义
+ */
 interface MessageEvents extends BaseEvents {
   /**
    * 服务接收数据
+   * @param {MessagePackage} data 消息数据
+   * @param {(...params:any) => any} [cb] 回调函数
    */
   message: (data: MessagePackage, cb?: (...params: any) => any) => void;
 }
 //#endregion
 //#region lib/events/room.d.ts
+/**
+ * 房间事件定义
+ */
 interface RoomEvents extends BaseEvents {
   /**
    * 加入房间
+   * @param {IRoomPlayer} player 玩家信息
    **/
   join: (player: IRoomPlayer) => void;
   /**
    * 离开房间
+   * @param {IRoomPlayer} player 玩家信息
    **/
   leave: (player: IRoomPlayer) => void;
   /**
    * 房间状态变化
+   * @param {RoomStatus} status 房间状态
    **/
   status: (status: RoomStatus) => void;
   /**
    * 房间聊天
+   * @param {string} data 消息内容
    **/
   message: (data: string) => void;
   /**
    * 玩家发送的房间命令
+   * @param {MessagePackage} message 命令内容
    */
   'player-command': (message: MessagePackage) => void;
   /**
    * 房间命令
+   * @param {MessagePackage} message 命令内容
    */
   command: (message: MessagePackage) => void;
   /**
    * 房间更新
+   * @param {IRoom} room 房间信息
    */
   update: (room: IRoom) => void;
   /**
    * 玩家准备
+   * @param {IRoomPlayer} player 玩家信息
    */
   'player-ready': (player: IRoomPlayer) => void;
   /**
    * 全部玩家已准备
+   * @param {IRoomPlayer[]} players 玩家列表
    */
   'all-ready': (players: IRoomPlayer[]) => void;
   /**
    * 玩家取消准备
+   * @param {IRoomPlayer} player 玩家信息
    */
   'player-unready': (player: IRoomPlayer) => void;
   /**
    * 房间开始游戏
+   * @param {IRoom} room 房间信息
    */
   start: (room: IRoom) => void;
   /**
    * 房间结束游戏
+   * @param {IRoom} room 房间信息
    */
   end: (room: IRoom) => void;
 }
@@ -172,33 +307,33 @@ interface RoomEvents extends BaseEvents {
 interface TiaoomEvents extends BaseEvents {
   /**
    * 房间创建事件
-   * @param room 房间信息
+   * @param {Room} room 房间信息
    */
   room: (room: Room) => void;
   /**
    * 返回房间列表
-   * @param rooms 房间列表
+   * @param {Room[]} rooms 房间列表
    */
   rooms: (rooms: Room[]) => void;
   /**
    * 房间玩家变更事件
-   * @param room 房间信息
+   * @param {Room} room 房间信息
    */
   'room-player': (room: Room) => void;
   /**
    * 玩家变更事件
-   * @param player 玩家信息
-   * @param online 是否在线
+   * @param {Player} player 玩家信息
+   * @param {boolean} online 是否在线
    */
   player: (player: Player, online: boolean) => void;
   /**
    * 返回玩家列表
-   * @param players 玩家列表
+   * @param {Player[]} players 玩家列表
    */
   players: (players: Player[]) => void;
   /**
    * 全局命令事件
-   * @param command 命令内容
+   * @param {any & { sender: Player }} data 命令内容
    */
   command: (data: any & {
     sender: Player;
@@ -206,48 +341,99 @@ interface TiaoomEvents extends BaseEvents {
 }
 //#endregion
 //#region lib/models/room.d.ts
+/**
+ * 房间选项接口
+ */
 interface IRoomOptions {
   /**
    * 房间号
    */
-  id?: string;
+  id: string;
   /**
    * 房间名称
    */
-  name?: string;
+  name: string;
   /**
    * 房间容量
    */
-  size?: number;
+  size: number;
   /**
    * 最小容量
    */
-  minSize?: number;
+  minSize: number;
   /**
    * 其他属性
    */
   attrs?: Record<string, any>;
 }
+/**
+ * 房间玩家角色
+ */
 declare enum PlayerRole {
+  /**
+   * 玩家
+   */
   player = "player",
+  /**
+   * 观众
+   */
   watcher = "watcher",
 }
+/**
+ * 房间状态
+ */
 declare enum RoomStatus {
+  /**
+   * 等待中
+   */
   waiting = "waiting",
+  /**
+   * 已准备
+   */
   ready = "ready",
+  /**
+   * 游戏中
+   */
   playing = "playing",
 }
+/**
+ * 房间接口
+ */
 interface IRoom extends IRoomOptions {
+  /**
+   * 房间玩家列表
+   */
   players: RoomPlayer[];
 }
+/**
+ * 房间玩家选项接口
+ */
 interface IRoomPlayerOptions extends PlayerOptions {
+  /**
+   * 房间Id
+   */
   roomId?: string;
 }
+/**
+ * 房间玩家接口
+ */
 interface IRoomPlayer extends IRoomPlayerOptions, IPlayer {
+  /**
+   * 是否已准备
+   */
   isReady: boolean;
+  /**
+   * 玩家角色
+   */
   role: PlayerRole;
+  /**
+   * 是否为房主
+   */
   isCreator: boolean;
 }
+/**
+ * 房间玩家
+ */
 declare class RoomPlayer extends Player implements IRoomPlayer {
   isReady: boolean;
   role: PlayerRole;
@@ -264,8 +450,23 @@ declare class RoomPlayer extends Player implements IRoomPlayer {
     status: PlayerStatus;
   };
 }
+/**
+ * 房间
+ */
 declare class Room extends EventEmitter$1 implements IRoom {
+  /**
+   * 监听房间事件
+   * @param event 事件名，具体见 RoomEvents
+   * @param listener 监听器
+   * @returns this
+   */
   on<K extends keyof RoomEvents>(event: K, listener: RoomEvents[K]): this;
+  /**
+   * 触发房间事件
+   * @param event 事件名，具体见 RoomEvents
+   * @param args 参数
+   * @returns 是否有监听器被触发
+   */
   emit<K extends keyof RoomEvents>(event: K, ...args: Parameters<RoomEvents[K]>): boolean;
   id: string;
   size: number;
@@ -273,13 +474,38 @@ declare class Room extends EventEmitter$1 implements IRoom {
   minSize: number;
   attrs?: Record<string, any>;
   players: RoomPlayer[];
+  /**
+   * 有效玩家列表(非观众)
+   */
   get validPlayers(): RoomPlayer[];
+  /**
+   * 观众列表
+   */
   get watchers(): RoomPlayer[];
+  /**
+   * 消息发送器
+   */
   private sender?;
+  /**
+   * 房间玩家是否已准备好
+   */
   get isReady(): boolean;
+  /**
+   * 房间状态
+   */
   get status(): RoomStatus;
+  /**
+   * 房间是否在游戏中
+   */
   get isPlaying(): boolean;
+  /**
+   * 房间是否已满
+   */
   get isFull(): boolean;
+  /**
+   * 房主
+   */
+  get owner(): RoomPlayer | undefined;
   toJSON(): {
     id: string;
     name: string;
@@ -304,15 +530,44 @@ declare class Room extends EventEmitter$1 implements IRoom {
     size,
     minSize,
     attrs
-  }: IRoomOptions);
+  }: Partial<IRoomOptions>);
+  /**
+   * 设置房主
+   * @param {Player} player 玩家
+   * @returns this
+   */
   setCreator(player: Player): this;
-  addPlayer(player: Player, isCreator?: boolean): RoomPlayer | undefined;
+  /**
+   * 添加玩家
+   * @param {Player} player 玩家
+   * @param {boolean} isCreator 是否房主
+   * @returns 玩家实例
+   */
+  addPlayer(player: Player, isCreator?: boolean): RoomPlayer;
+  /**
+   * 踢出玩家
+   * @param {string | IPlayer} player 玩家 / 玩家 id
+   */
   kickPlayer(playerId: string): RoomPlayer;
   kickPlayer(player: IPlayer): RoomPlayer;
+  /**
+   * 搜索玩家
+   * @param {string | IPlayer} player 玩家 / 玩家 id
+   */
   searchPlayer(playerId: string): RoomPlayer | undefined;
-  searchPlayer(playerId: IPlayer): RoomPlayer | undefined;
+  searchPlayer(player: IPlayer): RoomPlayer | undefined;
+  /**
+   * 开始游戏
+   */
   start(): boolean;
+  /**
+   * 结束游戏
+   */
   end(): boolean;
+  /**
+   * 设置消息发送器
+   * @param sender 消息发送器
+   */
   setSender(sender: (type: string, ...message: any) => void): this;
 }
 //#endregion