Interface App

interface App {
    registCommand: ((config) => void);
    registGlobalMessageHandle: ((config) => void);
    registReplyHandle: ((config) => void);
    get bot(): StdBot;
    get config(): YamlConfig;
    get configExample(): string;
    get db(): DBManager;
    get std(): Std;
    get version(): string;
    init(): Promise<void>;
}

Implemented by

Application

Index

Properties

registCommand registGlobalMessageHandle registReplyHandle

Accessors

bot config configExample db std version

Methods

Properties

registCommand

registCommand: ((config) => void)

Type declaration

- (config): void
- 注册一个斜杠Bot指令.
  Parameters
  - config: CommandHandleConfig
    请参阅commandConfig
  Returns void

registGlobalMessageHandle

registGlobalMessageHandle: ((config) => void)

Type declaration

- (config): void
- 注册全局消息处理器
  Parameters
  - config: MessageHandleConfig
    MessageHandleConfig
  Returns void

registReplyHandle

registReplyHandle: ((config) => void)

Type declaration

- (config): void
- 注册回复消息处理器
  Parameters
  - config: ReplyHandleConfig
    replyHandleConfig
  Returns void

Accessors

bot

get bot(): StdBot
Telegram bot

Returns StdBot
- Defined in types/app.ts:15

config

get config(): YamlConfig
用户在 config.yml 的配置

Returns YamlConfig
- Defined in types/app.ts:11

configExample

get configExample(): string
获取配置示例

Returns string
- Defined in types/app.ts:36

db

get db(): DBManager
Returns DBManager
- Defined in types/app.ts:21

std

get std(): Std
获得标准输入输出交互器

Returns Std
- Defined in types/app.ts:26

version

get version(): string
获取版本号

Returns string
- Defined in types/app.ts:31

Methods

init

init(): Promise<void>
初始化app。只应执行一次。

Returns Promise<void>
- Defined in types/app.ts:19

Generated using TypeDoc