minigame-std
    Preparing search index...

    Interface FilePluginAPI

    文件插件 API 接口。

    2.6.0

    interface FilePluginAPI {
        name: string;
        onDestroy?: () => void;
        onInit?: (ctx: PluginContext) => void;
        onLog?: (level: LogLevel, ...args: unknown[]) => void;
        flush(): Promise<void>;
        getFiles(query?: LogFileQuery): AsyncIOResult<string[]>;
        getRootDir(): string;
    }

    Hierarchy (View Summary)

    Index
    name: string

    插件名称,用于标识和调试。

    onDestroy?: () => void

    插件销毁回调。

    由 logger 核心在 init 重新初始化时对旧插件调用,用于清理资源 (如 clearInterval、移除事件监听等)。

    onInit?: (ctx: PluginContext) => void

    插件初始化回调。

    logger 核心在 init 时调用,传入全局上下文,插件可据此继承全局配置。

    onLog?: (level: LogLevel, ...args: unknown[]) => void

    日志分发回调。

    logger 核心在每条日志通过级别与 filter 后调用,接收原始参数 (level, ...args),由插件自行决定格式化与落盘策略。