@hongtangyun/rooms-sdk/dist/cjs/socket/utils.d.ts

JavaScript SDK Client for hongtangyun rooms-sdk.

import { IRoomActions, RoomEvents, ToSystemEnum } from './types';
/**
 * 生成房间操作动作
 * @param action 动作名
 * @param data 动作数据
 * @param roomid 房间id
 * @param publisher 动作用户uid
 * @param to 指定用户
 * @param customroom 指定自定义房间id
 * @returns 动作
 */
export declare function createRoomAction<T extends keyof IRoomActions, K extends IRoomActions[T]>(action: T, data: K, roomid: string, publisher: number | ToSystemEnum, to?: number | string | Array<number | string> | ToSystemEnum, customroom?: string[]): Omit<RoomEvents, 'role'>;
/**
 * 检查动作是否正确
 * @param actionData
 * @returns
 */
export declare function checkAction(actionData: RoomEvents): {
    error: string[] | undefined;
    success: boolean;
};
/**
 * 获取动作唯一key
 * @param data
 * @returns
 */
export declare function getActionKey(actionData: RoomEvents): string;