el-bot

Index

References

default

Namespaces

Classes

Bot

Interfaces

Type aliases

Functions

References

default

Renames and re-exports Bot

Type aliases

BotUserConfig

BotUserConfig: Partial<BotConfig>

ElUserConfig

ElUserConfig: Partial<ElConfig<BotUserConfig>>

Functions

createBot

createBot(el: Partial<ElConfig<Partial<BotConfig>>>): Bot

- Defined in bot/index.ts:43
创建机器人

Parameters
- el: Partial<ElConfig<Partial<BotConfig>>>
Returns Bot

createLogger

createLogger(label?: string): Logger

- Defined in bot/logger.ts:32
创建日志工具，基于 winston

Parameters
- label: string = 'el-bot'
Returns Logger

defineBotConfig

defineBotConfig(config: Partial<BotConfig>): BotUserConfig

- Defined in config/index.ts:89
Bot 配置

Parameters
- config: Partial<BotConfig>
Returns BotUserConfig

defineConfig

defineConfig(config: Partial<ElConfig<Partial<BotConfig>>>): ElUserConfig

- Defined in config/index.ts:81
机器人全局配置

Parameters
- config: Partial<ElConfig<Partial<BotConfig>>>
Returns ElUserConfig

loadConfigFromFile

loadConfigFromFile(configFile?: string, configRoot?: string): Promise<undefined | null | BotConfig>

- Defined in config/index.ts:15
从文件加载配置

Parameters
- Optional configFile: string
- configRoot: string = ...
Returns Promise<undefined | null | BotConfig>

resolveElConfig

resolveElConfig(userConfig: Partial<ElConfig<Partial<BotConfig>>>): ElConfig<BotConfig>

- Defined in config/el.ts:100
解析 El Config

Parameters
- userConfig: Partial<ElConfig<Partial<BotConfig>>>
Returns ElConfig<BotConfig>

Generated using TypeDoc