@group_wtf_npm/message/index.d.ts

message提示

// 导入模块的类型
import GlobalMessage from './src/GlobalMessage.js';
import WtfLoading from './src/WtfMessage.js';

/**
 * GlobalMessage 类
 * 用于管理全局消息提示的类，支持显示、隐藏、通知等功能。
 */
export 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;
}

/**
 * WtfLoading 类
 *
 * 自定义元素，用于显示加载动画的 Web Component。
 */
export declare class WtfLoading extends HTMLElement {
    /**
     * 构造函数
     */
    constructor();

    /**
     * 生命周期回调：connectedCallback
     * 当元素被插入到 DOM 中时调用。
     */
    connectedCallback(): void;

    /**
     * 生命周期回调：disconnectedCallback
     * 当元素从 DOM 中移除时调用。
     */
    disconnectedCallback(): void;

    /**
     * 设置属性时触发的回调
     * @param name 属性名称
     * @param oldValue 属性的旧值
     * @param newValue 属性的新值
     */
    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;

    /**
     * 观察的属性列表
     */
    static get observedAttributes(): string[];
}

/**
 * 初始化全局加载管理器
 *
 * 该函数用于注册自定义元素 `wtf-loading`，并返回一个全局加载管理器的实例。
 * 如果自定义元素已经注册，则不会重复注册。
 *
 * @param tag 自定义元素的名称，默认为 `wtf-loading`。
 * @param userOpts 其它配置项
 * @returns 返回一个全局加载管理器的实例。
 */
declare function initGlobalMessage(tag?: string, userOpts?: object): GlobalMessage;

export default initGlobalMessage;