tachybase_todo/docs/reference/application.md

122 lines
1.5 KiB
Markdown
Raw Normal View History

# Application
2021-11-09 15:08:24 +08:00
## `app.db`
2021-11-09 15:08:24 +08:00
数据库实例,详情见 [Database API](database)
##### Definition
```ts
class Application {
public db: Database;
}
```
##### Examples
```ts
app.db.on('xxx', () => {
});
```
## app.resourcer
资源实例
2021-11-17 18:54:32 +08:00
## app.pm <Badge>待完善</Badge>
2021-11-09 15:08:24 +08:00
插件管理器,详情见 [Plugin Manager](plugin-manager)
##### Definition
```ts
class Application {
public pm: PluginManager;
}
```
##### Examples
```ts
app.pm.enable(['plugin-name']);
```
## app.i18n
2021-11-09 15:08:24 +08:00
国际化i18next 实例,详情见 [I18next API](https://www.i18next.com/overview/api),在 Middleware 里请使用 [ctx.i18n](context#ctxi18n)
##### Definition
```ts
class Application {
public i18n: I18next.i18n;
}
```
##### Examples
```ts
app.i18n.t('Hello');
```
## app.constructor()
构造器
2021-11-17 18:54:32 +08:00
## app.use() <Badge>待完善</Badge>
2021-11-17 18:54:32 +08:00
添加中间件
## app.unuse() <Badge>待完善</Badge>
移除中间件
## app.on()
事件
## app.emit()
## app.emitAsync()
## app.collection()
等同于 app.db.collection()
2021-11-17 18:54:32 +08:00
## app.actions() <Badge>待完善</Badge>
等同于 app.resourcer.registerActions()
2021-11-17 18:54:32 +08:00
## app.resource() <Badge>待完善</Badge>
等同于 app.resourcer.define()
## app.parse()
等同于 app.cli.parse()
2021-11-17 18:54:32 +08:00
## app.load() <Badge>待完善</Badge>
加载配置
2021-11-17 18:54:32 +08:00
## app.init() <Badge>待完善</Badge>
初始化
2021-11-17 18:54:32 +08:00
## app.start() <Badge>待完善</Badge>
启动应用
2021-11-17 18:54:32 +08:00
## app.stop() <Badge>待完善</Badge>
停止应用
## app.command()
等同于 app.cli.command()
## app.plugin()
2021-11-17 18:54:32 +08:00
等同于 app.pm.add()