@group_wtf_npm/message
Version:
message提示
45 lines (40 loc) • 1.29 kB
TypeScript
/**
* GlobalMessage 类
* 用于管理全局消息提示的类,支持显示、隐藏、通知等功能。
*/
export default class GlobalMessage {
constructor(opts?: { root?: HTMLElement | string; tag?: string; delay?: number });
/**
* 显示消息
* @param userOpts 用户配置项
* @param callback 消息隐藏后的回调函数
* @returns 返回消息的唯一 ID
*/
show(
userOpts: { msg: string; id?: string; tag?: string; type?: string; delay?: number },
callback?: () => void
): string;
/**
* 隐藏指定的消息
* @param id 消息的唯一 ID
*/
hide(id: string): void;
/**
* 通知消息
* @param type 消息类型
* @param msg 消息内容
* @param useOpts 额外的配置项
* @returns 返回一个 Promise
*/
notify(type: string, msg: string, useOpts?: object): Promise<void>;
success(msg: string, useOpts?: object): Promise<void>;
error(msg: string, useOpts?: object): Promise<void>;
warn(msg: string, useOpts?: object): Promise<void>;
info(msg: string, useOpts?: object): Promise<void>;
/**
* 生成唯一 ID
* @param num ID 的长度
* @returns 返回生成的唯一 ID
*/
getId(num?: number): string;
}