miraipie/types/config.d.ts

the most powerful nodejs development kit for mirai-api-http

/** 配置类型 */
import { Logger } from 'log4js';
declare type ConfigConstructor<T> = {
    new (...args: any[]): T & {};
    (...args: []): T;
};
/** 配置默认值工厂函数 */
declare type ConfigDefaultFactory<T> = (...args: []) => T;
/** 配置项 */
declare type Config<T = any> = {
    /** 配置类型 */
    type: ConfigConstructor<T>;
    /** 是否必要 */
    required?: boolean;
    /** 配置项描述 */
    description?: string;
    /** 默认值工厂函数 */
    default?: ConfigDefaultFactory<T>;
};
/** 配置元定义 */
export declare type ConfigMeta = {
    [key: string]: Config;
};
/** 用户配置 */
export declare type UserConfigs<C extends ConfigMeta> = {
    [P in keyof C]: ReturnType<C[P]['type']>;
};
/** 通过元定义生成默认用户配置 */
export declare function makeConfigs<C extends ConfigMeta>(configMeta: C): UserConfigs<C>;
export declare function checkUserConfig<C extends ConfigMeta>(configMeta: C, configs: Partial<UserConfigs<C>>, logger?: Logger): void;
/** 拓展项基础配置 */
interface BaseExtensionConfig {
    /** 拓展项模块路径 */
    module?: string;
    /** 用户配置 */
    configs: object;
}
/** adapter 配置 */
declare type AdapterConfig = BaseExtensionConfig;
/** pie 配置 */
interface PieConfig extends BaseExtensionConfig {
    /** pie 是否启用 */
    enabled: boolean;
}
/** MiraiPie 应用程序配置 */
export interface ApplicationConfig {
    /** 机器人服务的QQ号 */
    qq: number;
    /** 当前选用的 adapter */
    adapterInUse: 'http' | 'ws' | 'mixed' | string;
    /** 日志存放文件夹, null 时不写入日志 */
    logDirectory: string;
    /** 日志级别 */
    logLevel: 'debug' | 'info' | 'error' | string;
    /** 是否打印接收到的消息和事件 */
    verbose: boolean;
    /** adapter 配置 */
    adapters: {
        [id: string]: AdapterConfig;
    };
    /** pie 配置 */
    pies: {
        [id: string]: PieConfig;
    };
    /** 额外的拓展 */
    extensions: string[];
}
export declare class ApplicationConfig {
    /** 机器人服务的QQ号 */
    qq: number;
    /** 当前选用的 adapter */
    adapterInUse: 'http' | 'ws' | 'mixed' | string;
    /** 日志存放文件夹, null 时不写入日志 */
    logDirectory: string;
    /** 日志级别 */
    logLevel: 'debug' | 'info' | 'error' | string;
    /** 是否打印接收到的消息和事件 */
    verbose: boolean;
    /** adapter 配置 */
    adapters: {
        [id: string]: AdapterConfig;
    };
    /** pie 配置 */
    pies: {
        [id: string]: PieConfig;
    };
    /** 额外的拓展 */
    extensions: string[];
    static make(config: Partial<ApplicationConfig>): ApplicationConfig;
}
export {};
//# sourceMappingURL=config.d.ts.map