Update application.md
This commit is contained in:
parent
934a0c7b1b
commit
a8d59496d7
@ -137,7 +137,7 @@ Use the `upgrade` command in `cli` to upgrade NocoBase Web service when needed.
|
|||||||
|
|
||||||
### `constructor()`
|
### `constructor()`
|
||||||
|
|
||||||
Create an instance.
|
Create an application instance.
|
||||||
|
|
||||||
**Signature**
|
**Signature**
|
||||||
|
|
||||||
@ -215,86 +215,86 @@ Built-in middleware includes:
|
|||||||
|
|
||||||
Context inherited from koa, accessible via `app.context`, is used to inject context-accessible content to each request. Refer to [Koa Context](https://koajs.com/#app-context).
|
Context inherited from koa, accessible via `app.context`, is used to inject context-accessible content to each request. Refer to [Koa Context](https://koajs.com/#app-context).
|
||||||
|
|
||||||
NocoBase injects the following members to context by default, which can be used directly in the request function:
|
NocoBase injects the following members to context by default, which can be used directly in the request handler function:
|
||||||
|
|
||||||
| 变量名 | 类型 | 描述 |
|
| Variable Name | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `ctx.app` | `Application` | 应用实例 |
|
| `ctx.app` | `Application` | Application instance |
|
||||||
| `ctx.db` | `Database` | 数据库实例 |
|
| `ctx.db` | `Database` | Database instance |
|
||||||
| `ctx.resourcer` | `Resourcer` | 资源路由管理器实例 |
|
| `ctx.resourcer` | `Resourcer` | Resource route manager instance |
|
||||||
| `ctx.action` | `Action` | 资源操作相关对象实例 |
|
| `ctx.action` | `Action` | Resource action related object instance |
|
||||||
| `ctx.logger` | `Winston` | 日志实例 |
|
| `ctx.logger` | `Winston` | Log instance |
|
||||||
| `ctx.i18n` | `I18n` | 国际化实例 |
|
| `ctx.i18n` | `I18n` | Internationlization instance |
|
||||||
| `ctx.t` | `i18n.t` | 国际化翻译函数快捷方式 |
|
| `ctx.t` | `i18n.t` | Shortcut of internationalized translation function |
|
||||||
| `ctx.getBearerToken()` | `Function` | 获取请求头中的 bearer token |
|
| `ctx.getBearerToken()` | `Function` | Get the bearer token in the header of request |
|
||||||
|
|
||||||
## 实例方法
|
## Instance Methods
|
||||||
|
|
||||||
### `use()`
|
### `use()`
|
||||||
|
|
||||||
注册中间件,兼容所有 [Koa 插件](https://www.npmjs.com/search?q=koa)
|
Register middleware, compatible with all [Koa plugins](https://www.npmjs.com/search?q=koa).
|
||||||
|
|
||||||
### `on()`
|
### `on()`
|
||||||
|
|
||||||
订阅应用级事件,主要与生命周期相关,等同于 `eventEmitter.on()`。所有可订阅事件参考 [事件](#事件)。
|
Subscribe to application-level events, mainly are related to life cycle. It is equivalent to `eventEmitter.on()`. Refer to [events](#events) for all subscribable events.
|
||||||
|
|
||||||
### `command()`
|
### `command()`
|
||||||
|
|
||||||
自定义 command
|
Customize command.
|
||||||
|
|
||||||
### `findCommand()`
|
### `findCommand()`
|
||||||
|
|
||||||
查找已定义 command
|
Find defined command.
|
||||||
|
|
||||||
### `runAsCLI()`
|
### `runAsCLI()`
|
||||||
|
|
||||||
以 CLI 的方式运行。
|
Run as CLI.
|
||||||
|
|
||||||
### `load()`
|
### `load()`
|
||||||
|
|
||||||
加载应用配置。
|
Load application configuration.
|
||||||
|
|
||||||
**签名**
|
**Signature**
|
||||||
|
|
||||||
* `async load(): Promise<void>`
|
* `async load(): Promise<void>`
|
||||||
|
|
||||||
### `reload()`
|
### `reload()`
|
||||||
|
|
||||||
重载应用配置。
|
Reload application configuration.
|
||||||
|
|
||||||
### `install()`
|
### `install()`
|
||||||
|
|
||||||
初始化安装应用,同步安装插件。
|
Initialize the installation of the application, meanwhile, install the plugin.
|
||||||
|
|
||||||
### `upgrade()`
|
### `upgrade()`
|
||||||
|
|
||||||
升级应用,同步升级插件。
|
Upgrade application, meanwhile, upgrade plugin.
|
||||||
|
|
||||||
### `start()`
|
### `start()`
|
||||||
|
|
||||||
启动应用,如果配置了监听的端口,将启动监听,之后应用即可接受 HTTP 请求。
|
Start application, listening will also be started if the listening port is configured, then the application can accept HTTP requests.
|
||||||
|
|
||||||
**签名**
|
**Signature**
|
||||||
|
|
||||||
* `async start(options: StartOptions): Promise<void>`
|
* `async start(options: StartOptions): Promise<void>`
|
||||||
|
|
||||||
**参数**
|
**Parameters**
|
||||||
|
|
||||||
| 参数名 | 类型 | 默认值 | 描述 |
|
| Name | Type | Default | Description |
|
||||||
| --- | --- | --- | --- |
|
| --- | --- | --- | --- |
|
||||||
| `options.listen?` | `ListenOptions` | `{}` | HTTP 监听参数对象 |
|
| `options.listen?` | `ListenOptions` | `{}` | HTTP Listening parameters object |
|
||||||
| `options.listen.port?` | `number` | 13000 | 端口 |
|
| `options.listen.port?` | `number` | 13000 | Port |
|
||||||
| `options.listen.host?` | `string` | `'localhost'` | 域名 |
|
| `options.listen.host?` | `string` | `'localhost'` | Domain name |
|
||||||
|
|
||||||
### `stop()`
|
### `stop()`
|
||||||
|
|
||||||
停止应用,此方法会关闭数据库连接,关闭 HTTP 端口,不会删除数据。
|
Stop application. This method will deconnect database, close HTTP port, but will not delete data.
|
||||||
|
|
||||||
### `destroy()`
|
### `destroy()`
|
||||||
|
|
||||||
删除应用,此方法会删除应用对应的数据库。
|
Delete application. This methos will delete the corresponding database of application.
|
||||||
|
|
||||||
## 事件
|
## Events
|
||||||
|
|
||||||
### `'beforeLoad'` / `'afterLoad'`
|
### `'beforeLoad'` / `'afterLoad'`
|
||||||
### `'beforeInstall'` / `'afterInstall'`
|
### `'beforeInstall'` / `'afterInstall'`
|
||||||
|
Loading…
Reference in New Issue
Block a user