Midway

https://www.midwayjs.org/docs/3.0.0/
Admin
Midway is a progressive Node.js framework developed with TypeScript that combines OOP and FP...
Tokens:503,287
Snippets:3,758
Trust Score:8
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /hello

Source: https://www.midwayjs.org/docs/3.0.0/hooks/api

Example of creating a GET endpoint with a custom path using the Api() and Get() functions.

```APIDOC
## [GET] /hello

### Description
Creates a GET endpoint at the specified path '/hello'.

### Method
GET

### Endpoint
/hello

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (string) - The response body is 'Hello World!'.

#### Response Example
"Hello World!"
```

--------------------------------

### Start Node service with ENABLE_NODE_LOG=YES

Source: https://www.midwayjs.org/docs/3.0.0/extensions/alinode

When starting the Node service on the server, include the ENABLE_NODE_LOG=YES environment variable to enable logging for Alinode. Example uses NODE_ENV=production.

```bash
$ NODE_ENV=production ENABLE_NODE_LOG=YES node bootstrap.js
```

--------------------------------

### GET /api/hello

Source: https://www.midwayjs.org/docs/3.0.0/hooks/api

Example of creating a GET endpoint using the Api() and Get() functions from @midwayjs/hooks.

```APIDOC
## [GET] /api/hello

### Description
Creates a GET endpoint that returns 'Hello World!'.

### Method
GET

### Endpoint
/api/hello

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (string) - The response body is 'Hello World!'.

#### Response Example
"Hello World!"
```

--------------------------------

### GET /api/hello (with context)

Source: https://www.midwayjs.org/docs/3.0.0/hooks/api

Example of using useContext to access the request context and return the method and path.

```APIDOC
## [GET] /api/hello (with context)

### Description
Creates a GET endpoint that uses the request context to return the HTTP method and path.

### Method
GET

### Endpoint
/api/hello

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **method** (string) - The HTTP method of the request.
- **path** (string) - The path of the request.

#### Response Example
{
  "method": "GET",
  "path": "/api/hello"
}
```

--------------------------------

### Start application with egg-scripts

Source: https://www.midwayjs.org/docs/3.0.0/extensions/egg

Example of starting the application with egg-scripts. Supports parameters like --port, --daemon, --env, --workers, --title, --framework, --ignore-stderr, --https.key, and --https.cert. Logs are stored in the user's home directory.

```bash
$ egg-scripts start --port=7001 --daemon --title=egg-server-showcase
```

--------------------------------

### Complete test example with createApp, close, and createHttpRequest

Source: https://www.midwayjs.org/docs/3.0.0/testing

A full test file example showing how to set up and tear down an app, and test GET and POST endpoints using both Jest expect and Node assert.

```typescript
import { createApp, close, createHttpRequest } from '@midwayjs/mock';
import { Framework, Application } from '@midwayjs/koa';
import * as assert from 'assert';

describe('test/controller/home.test.ts', () => {

  let app: Application;

  beforeAll(async () => {
    // 只创建一次 app，可以复用
    app = await createApp<Framework>();
  });

  afterAll(async () => {
    // close app
    await close(app);
  });

  it('should GET /', async () => {
    // make request
    const result = await createHttpRequest(app)
      .get('/')
      .set('x-timeout', '5000');

    // use expect by jest
    expect(result.status).toBe(200);
    expect(result.text).toBe('Hello Midwayjs!');

    // or use assert
    assert.deepStrictEqual(result.status, 200);
    assert.deepStrictEqual(result.text, 'Hello Midwayjs!');
  });

  it('should POST /', async () => {
    // make request
    const result = await createHttpRequest(app)
      .post('/')
      .send({id: '1'});

    // use expect by jest
    expect(result.status).toBe(200);
  });

});
```

--------------------------------

### Install @midwayjs/jwt and passport-jwt

Source: https://www.midwayjs.org/docs/3.0.0/extensions/passport

Install the required dependencies for the JWT strategy example.

```bash
$ npm i @midwayjs/jwt passport-jwt --save
```

--------------------------------

### GET /api/hello (set header)

Source: https://www.midwayjs.org/docs/3.0.0/hooks/api

Example of setting a response header using the context object.

```APIDOC
## [GET] /api/hello (set header)

### Description
Creates a GET endpoint that sets a custom response header using the context.

### Method
GET

### Endpoint
/api/hello

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **X-Powered-By** (string) - The header set to 'Midway'.
- **body** (string) - The response body is 'Hello World!'.

#### Response Example
Headers: X-Powered-By: Midway
Body: "Hello World!"
```

--------------------------------

### Version compatibility mapping example for @midwayjs/version

Source: https://www.midwayjs.org/docs/3.0.0/how_to_update_midway

Example version mapping file from the @midwayjs/version package. Filenames follow `decoratorVersion-coreVersion.json`; each key maps to a compatible version or array of compatible versions. If a filename is missing or versions don't match, the version setup may be broken.

```json
{
  "@midwayjs/egg-layer": [
    "2.10.18",
    "2.10.19"
  ],
  "@midwayjs/express-layer": "2.10.18",
  "@midwayjs/faas-typings": "2.10.7",
  "@midwayjs/koa-layer": "2.10.18",
  "@midwayjs/runtime-engine": "2.10.14",
  "@midwayjs/runtime-mock": "2.10.14",
  "@midwayjs/serverless-app": "2.10.18",
  "@midwayjs/serverless-aws-starter": "2.10.14",
  "@midwayjs/serverless-fc-starter": "2.10.18",
  "@midwayjs/serverless-fc-trigger": "2.10.18",
  "@midwayjs/serverless-http-parser": "2.10.7",
  "@midwayjs/serverless-scf-starter": "2.10.14",
  "@midwayjs/serverless-scf-trigger": "2.10.18",
  "@midwayjs/static-layer": "2.10.18",
  "@midwayjs/bootstrap": "2.10.18",
  "@midwayjs/cache": "2.10.18",
  "@midwayjs/consul": "2.10.18",
  "@midwayjs/core": "2.10.18",
  "@midwayjs/decorator": "2.10.18",
  "@midwayjs/faas": "2.10.18",
  "@midwayjs/grpc": "2.10.18",
  "@midwayjs/logger": "2.10.18",
  "midway-schedule": "2.10.18",
  "midway": [
    "2.10.18",
    "2.10.19"
  ],
  "@midwayjs/mock": "2.10.18",
  "@midwayjs/prometheus": "2.10.18",
  "@midwayjs/rabbitmq": "2.10.18",
  "@midwayjs/socketio": "2.10.18",
  "@midwayjs/task": [
    "2.10.18",
    "2.10.19"
  ],
  "@midwayjs/typegoose": "2.10.18",
  "@midwayjs/version": [
    "2.10.18",
    "2.10.19"
  ],
  "@midwayjs/express": "2.10.18",
  "@midwayjs/koa": "2.10.18",
  "@midwayjs/web": [
    "2.10.18",
    "2.10.19"
  ]
}
```

--------------------------------

### Install Serverless Devs tool globally

Source: https://www.midwayjs.org/docs/3.0.0/serverless/aliyun_faas

Install the Serverless Devs CLI globally using npm. After installation, configure credentials as per the referenced documentation.

```bash
$ npm install @serverless-devs/s -g

```

--------------------------------

### Install @midwayjs/grpc and @midwayjs/grpc-helper

Source: https://www.midwayjs.org/docs/3.0.0/extensions/grpc

Install the required gRPC dependencies for Midway. The first command installs the main gRPC module, and the second installs the helper package as a development dependency.

```bash
$ npm i @midwayjs/grpc@3 --save
$ npm i @midwayjs/grpc-helper --save-dev
```

--------------------------------

### Install @midwayjs/static-file

Source: https://www.midwayjs.org/docs/3.0.0/extensions/static_file

Install the @midwayjs/static-file component for Midway 3.x.

```bash
$ npm i @midwayjs/static-file@3 --save
```

--------------------------------

### Start bundled application

Source: https://www.midwayjs.org/docs/3.0.0/deployment

Start the built single-file application in production mode. If startup and access are successful, the build directory can be distributed.

```bash
$ npm run bundle_start
```

--------------------------------

### 构建 Docker 镜像

Source: https://www.midwayjs.org/docs/3.0.0/deployment

使用 docker build 命令构建镜像，镜像名为 helloworld。

```bash
$ docker build -t helloworld .
```

--------------------------------

### Install Jaeger Exporter Dependencies

Source: https://www.midwayjs.org/docs/3.0.0/extensions/otel

Installs the Jaeger exporter and propagator packages required for the Jaeger Exporter example.

```bash
$ npm install --save @opentelemetry/exporter-jaeger @opentelemetry/propagator-jaeger
```

--------------------------------

### Set, get, and reset cache data

Source: https://www.midwayjs.org/docs/3.0.0/extensions/cache

Example service showing how to set, get, and reset cache data using the CacheManager API.

```typescript
import { Inject, Provide } from '@midwayjs/core';
import { IUserOptions } from '../interface';
import { CacheManager } from '@midwayjs/cache';

@Provide()
export class UserService {

  @Inject()
  cacheManager: CacheManager;

  async getUser(options: IUserOptions) {
    // 设置缓存内容
    await this.cacheManager.set(`name`, 'stone-jin');

    // 获取缓存内容
    let result = await this.cacheManager.get(`name`);

    return result;
  }

  async getUser2(){
    //获取缓存内容
    let result = await this.cacheManager.get(`name`);
    return result;
  }

  async reset(){
    await this.cacheManager.reset(); // 清空对应 store 的内容
  }
}
```

--------------------------------

### 默认行为：列出模板列表

Source: https://www.midwayjs.org/docs/3.0.0/tool/create_midway

执行 npm init midway 后，会显示可选的模板列表，用户选择后按指引创建模板。

```bash
$ npm init midway@latest -y
```

```text
➜  ~ npm init midway
? Hello, traveller.
  Which template do you like? …

 ⊙ v3
❯ koa-v3 - A web application boilerplate with midway v3(koa)
  egg-v3 - A web application boilerplate with midway v3(egg 2.0)
  faas-v3 - A serverless application boilerplate with midway v3(faas)
  component-v3 - A midway component boilerplate for v3
  quick-start - A midway quickstart exmaple for v3

 ⊙ v3-esm
  koa-v3-esm - A web application boilerplate with midway v3(koa)

 ⊙ v2
  web - A web application boilerplate with midway and Egg.js
  koa - A web application boilerplate with midway and koa
```

--------------------------------

### Annotated helloworld.proto with comments

Source: https://www.midwayjs.org/docs/3.0.0/extensions/grpc

The same `helloworld.proto` file with Chinese comments explaining the service, request, and response definitions. This is the version used for the subsequent demonstration.

```protobuf
syntax = "proto3";

package helloworld;

// 服务的定义
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// 服务的请求参数
message HelloRequest {
  string name = 1;
}

// 服务的响应参数
message HelloReply {
  string message = 1;
}

```

--------------------------------

### Get instances in Express middleware

Source: https://www.midwayjs.org/docs/3.0.0/container

Express middleware example showing how to get instances from the request-scoped container using req.requestContext. Use this when working with Express.

```typescript
import { UserService, Middleware } from './service/user';
import { NextFunction, Context, Response } from '@midwayjs/express';

@Middleware()
export class ReportMiddleware implements IMiddleware<Context, Response, NextFunction> {

  resolve() {
  	return async (req, res, next) => {
      const userService = await req.requestContext.getAsync<UserService>(UserService);
      // ...
      next();
    }
  }
}
```

--------------------------------

### Get data source via TypeORMDataSourceManager

Source: https://www.midwayjs.org/docs/3.0.0/extensions/orm

Gets a DataSource object by injecting the TypeORMDataSourceManager and calling getDataSource('default'). The example also checks connectivity with isConnected.

```typescript
import { Configuration } from '@midwayjs/core';
import { TypeORMDataSourceManager } from '@midwayjs/typeorm';

@Configuration({
  // ...
})
export class MainConfiguration {

  async onReady(container: IMidwayContainer) {
    const dataSourceManager = await container.getAsync(TypeORMDataSourceManager);
  	const conn = dataSourceManager.getDataSource('default');
    console.log(dataSourceManager.isConnected(conn));
  }
}
```

--------------------------------

### Start agenthub with yourconfig.json

Source: https://www.midwayjs.org/docs/3.0.0/extensions/alinode

Launch the Alinode agent using the configuration file created earlier. This starts the data collector for the Node.js performance platform.

```bash
agenthub start yourconfig.json
```

--------------------------------

### Default query array parsing example

Source: https://www.midwayjs.org/docs/3.0.0/extensions/koa

Example of a GET request with array-like query parameters and the default parsed result using querystring, which splits array data into separate keys.

```http
GET /query?a[0]=1&a[1]=2
```

```json
{
    "a[0]": 1,
    "a[1]": 2,
}
```

--------------------------------

### Build binary with bundle and pkg

Source: https://www.midwayjs.org/docs/3.0.0/deployment

Run the build commands: first npm run bundle to generate the entry file and build the TypeScript files, then npm run pkg to create the platform-specific binary. The resulting executable appears in the build directory.

```bash
$ npm run bundle
$ npm run pkg
```

--------------------------------

### Get instances in Koa middleware

Source: https://www.midwayjs.org/docs/3.0.0/container

Koa middleware example showing how to use the container API to get instances inside middleware. Demonstrates both generic and inferred types, and the request-scoped container.

```typescript
import { Middleware, ApplicationContext, IMiddleware } from '@midwayjs/core';
import { NextFunction, Context } from '@midwayjs/koa';
import { UserService } from './service/user.service';

@Middleware()
export class ReportMiddleware implements IMiddleware<Context, NextFunction> {
  @ApplicationContext()
  applicationContext: IMidwayContainer;

  resolve() {
  	return async(ctx, next) => {
      // 指定泛型类型，比如某个接口
      const userService1 = await this.applicationContext.getAsync<UserService>(UserService);
      // 不写泛型，也能推导出正确的类型
      const userService1 = await this.applicationContext.getAsync(UserService);

      // 下面的方法获取的服务和请求关联，可以注入上下文
      const userService2 = await ctx.requestContext.getAsync<UserService>(UserService);
      await next();
    }
  }
}
```

--------------------------------

### Project directory structure

Source: https://www.midwayjs.org/docs/3.0.0/container

Directory structure for the dependency injection example, showing the controller and service files under src.

```text
.
├── package.json
├── src
│   ├── controller							# 控制器目录
│   │   └── user.controller.ts
│   └── service			  					# 服务目录
│       └── user.service.ts
└── tsconfig.json
```

--------------------------------

### Start Midway dev server and open browser

Source: https://www.midwayjs.org/docs/3.0.0/quickstart

Starts the Midway HTTP server and opens the browser. Accessing http://127.0.0.1:7001 prints 'Hello midwayjs!'.

```bash
$ npm run dev
$ open http://localhost:7001
```

--------------------------------

### Install dependencies for binary deployment

Source: https://www.midwayjs.org/docs/3.0.0/deployment

Install the required dependencies for binary deployment: @midwayjs/bundle-helper to generate the entry file, and pkg to build the binary. The pkg package can be installed globally or locally (recommended).

```bash
## 用于生成入口
$ npm i @midwayjs/bundle-helper --save-dev

## 用于构建二进制文件
## 装到全局
$ npm i pkg -g
## 或者装到项目（推荐）
$ npm i pkg --save-dev
```

--------------------------------

### Basic helloworld.proto definition

Source: https://www.midwayjs.org/docs/3.0.0/extensions/grpc

A basic `proto/helloworld.proto` file defining the `Greeter` service with a `SayHello` RPC. Uses proto3 syntax and defines `HelloRequest` and `HelloReply` messages.

```protobuf
syntax = "proto3";

package helloworld;

service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

```

--------------------------------

### Get header parameter with @Headers() decorator

Source: https://www.midwayjs.org/docs/3.0.0/controller

Use this snippet to retrieve a request header value in a MidwayJS controller. The @Headers('cache-control') decorator injects the 'cache-control' header value. The example shows a GET endpoint that uses the decorator to access the header.

```typescript
// src/controller/user.ts
// GET /user/1
import { Controller, Get, Headers } from '@midwayjs/core';

@Controller('/user')
export class UserController {
  @Get('/:uid')
  async getUser(@Headers('cache-control') cacheSetting: string): Promise<User> {
    // no-cache
    // ...
  }
}
```

--------------------------------

### Get App Instance with getApp

Source: https://www.midwayjs.org/docs/3.0.0/req_res_app

Retrieves the current framework's app object from the context. The comment shows an example of calling app.getConfig().

```typescript
const app = this.ctx.getApp();
// app.getConfig();
```

--------------------------------

### InitDataMock 模拟类（添加中间件）

Source: https://www.midwayjs.org/docs/3.0.0/mock

在 appSetup 中根据框架类型（koa、bull）添加不同的中间件和过滤器。

```typescript
import { App, IMidwayApplication, Mock, ISimulation } from '@midwayjs/core';

@Mock()
export class InitDataMock implements ISimulation {

  @App()
  app: IMidwayApplication;

  async appSetup(app: IMidwayApplication): Promise<void> {
    // 针对不同的框架类型，添加不同的测试中间件
    if (app.getNamespace() === 'koa') {
      app.useMiddleware(/*...*/);
      app.useFilter(/*...*/);
    }
    
    if (app.getNamespace() === 'bull') {
      app.useMiddleware(/*...*/);
      app.useFilter(/*...*/);
    }
  }

  enableCondition(): boolean | Promise<boolean> {
    return ['local', 'test', 'unittest'].includes(this.app.getEnv());
  }
}
```

--------------------------------

### Create HTTP client instance and configuration

Source: https://www.midwayjs.org/docs/3.0.0/service_factory

Shows how to create a client configuration object and instantiate an HTTP client with it. This is the initial example for the service factory scenario.

```typescript
// 创建客户端的配置
const config = {
  baseUrl: '',
  timeout: 1000,
};

// 创建客户端实例的方法
const httpClient = new HTTPClient(config);
```

--------------------------------

### Manually execute a job after startup

Source: https://www.midwayjs.org/docs/3.0.0/extensions/bull

Shows how to get the 'test' queue and add a job to it immediately after the application starts, using the bullFramework injection.

```typescript
import { Configuration, Inject } from '@midwayjs/core';
import * as bull from '@midwayjs/bull';

@Configuration({
  imports: [
    // ...
    bull
  ]
})
export class MainConfiguration {

  @Inject()
  bullFramework: bull.Framework;

  //...

  async onServerReady() {
    // 获取 Processor 相关的队列
    const testQueue = this.bullFramework.getQueue('test');
    // 立即添加这个任务
    await testQueue?.addJobToQueue();
  }
}
```

--------------------------------

### Get route parameter with @Param() decorator

Source: https://www.midwayjs.org/docs/3.0.0/controller

Use this snippet to retrieve a route parameter in a MidwayJS controller. The @Param('uid') decorator injects the 'uid' parameter from the URL path, equivalent to ctx.params.uid. The example shows a GET endpoint with a dynamic route segment.

```typescript
// src/controller/user.ts
// GET /user/1
import { Controller, Get, Param } from '@midwayjs/core';

@Controller('/user')
export class UserController {
  @Get('/:uid')
  async getUser(@Param('uid') uid: string): Promise<User> {
    // xxxx
  }
}
```

--------------------------------

### Get route parameter from context API

Source: https://www.midwayjs.org/docs/3.0.0/controller

Use this snippet to retrieve route parameters via the context object in a MidwayJS controller. The @Inject() decorator injects the Context, and this.ctx.params provides the route parameters. The example shows a GET endpoint with a dynamic route segment.

```typescript
// src/controller/user.ts
// GET /user/1
import { Controller, Get, Inject } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';

@Controller('/user')
export class UserController {

  @Inject()
  ctx: Context;

  @Get('/:uid')
  async getUser(): Promise<User> {
    const params = this.ctx.params;
    // {
    //   uid: '1',
    // }
  }
}
```

--------------------------------

### Install opentelemetry-arms SDK

Source: https://www.midwayjs.org/docs/3.0.0/extensions/otel

Installs the opentelemetry-arms SDK for Alibaba Cloud ARMS integration.

```bash
# arms sdk
$ npm install --save opentelemetry-arms
```

--------------------------------

### hooks build --help 输出

Source: https://www.midwayjs.org/docs/3.0.0/hooks/fullstack

`hooks build --help` 命令的输出，显示构建命令的用法和选项。

```text
Usage:
  $ hooks build [root]

Options:
  --outDir <dir>  [string] output directory (default: dist)
  --clean         [boolean] clean output directory before build (default: false)
  -h, --help      Display this message
```

--------------------------------

### Project directory structure

Source: https://www.midwayjs.org/docs/3.0.0/extensions/rabbitmq

Example directory structure for a Midway project with a consumer directory. Place consumer files in src/consumer.

```bash
➜  my_midway_app tree
.
├── src
│   ├── consumer
│   │   └── user.consumer.ts
│   ├── interface.ts
│   └── service
│       └── user.service.ts
├── test
├── package.json
└── tsconfig.json
```

--------------------------------

### Get Custom Logger with getLogger

Source: https://www.midwayjs.org/docs/3.0.0/req_res_app

Fetches a custom logger by name from the context. The example shows a comment indicating the returned logger is named 'custom'.

```typescript
this.ctx.getLogger('custom');
// => custom logger
```

--------------------------------

### Package and deploy with --function option

Source: https://www.midwayjs.org/docs/3.0.0/tool/cli

Examples of using the `--function` option to specify which functions to package and deploy. Multiple functions are separated by commas.

```bash
// 打包
midway-bin package --function=a,b,c

// 发布
midway-bin deploy --function=a,b,c
```

--------------------------------

### Get Request-Scoped Data with getAttr

Source: https://www.midwayjs.org/docs/3.0.0/req_res_app

Retrieves data previously stored with setAttr. The example logs the retrieved object, which outputs { a: 1, b: 2 }.

```typescript
const value = this.ctx.getAttr('abc');
console.log(value);
// { a: 1, b: 2 }
```

--------------------------------

### Get container in Configuration onReady

Source: https://www.midwayjs.org/docs/3.0.0/container

In the configuration lifecycle method onReady, the dependency injection container is passed as a parameter. Use it directly for setup tasks.

```typescript
// src/configuration.ts
import { Configuration, IMidwayContainer } from '@midwayjs/core';

@Configuration()
export class MainConfiguration {
  async onReady(applicationContext: IMidwayContainer) {
    // ...
  }
}
```

--------------------------------

### Example: host proxy configuration

Source: https://www.midwayjs.org/docs/3.0.0/extensions/http-proxy

Example of using the host option to replace the request host with https://gw.alicdn.com when the path matches /tfs/.

```typescript
export default {
  httpProxy: {
    match: /\/tfs\//,
    host: 'https://gw.alicdn.com',
  },
};
```

--------------------------------

### Install Express adapter dependencies

Source: https://www.midwayjs.org/docs/3.0.0/extensions/express

Install the Express adapter and its type definitions for Midway. Use this command in a Midway project to add Express support.

```bash
$ npm i @midwayjs/express@3 --save
$ npm i @types/body-parser @types/express @types/express-session --save-dev
```

--------------------------------

### Set and get cookies with ctx.cookies in @midwayjs/koa

Source: https://www.midwayjs.org/docs/3.0.0/cookie_session

Use this snippet in a MidwayJS Koa controller to set and get cookies via the context. The example sets a cookie named 'foo' with value 'bar' and the 'encrypt' option, then retrieves it with the same option. This is the default cookie API provided by @midwayjs/koa.

```typescript
import { Inject, Controller, Get, Provide } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';

@Controller('/')
export class HomeController {
  @Inject()
  ctx: Context;

  @Get('/')
  async home() {
    // set cookie
    this.ctx.cookies.set('foo', 'bar', { encrypt: true });
    // get cookie
    this.ctx.cookies.get('foo', { encrypt: true });
  }
}
```

--------------------------------

### Get main app with getCurrentMainApp

Source: https://www.midwayjs.org/docs/3.0.0/container

Use to obtain the main framework's app object after startup, for example to access global configuration via getConfig().

```typescript
import { getCurrentMainApp } from '@midwayjs/core';

export const getGlobalConfig = () => {
  return getCurrentMainApp().getConfig();
}
```

--------------------------------

### Run a transaction with dataSource.transaction

Source: https://www.midwayjs.org/docs/3.0.0/extensions/orm

Starts a transaction by getting the data source and calling dataSource.transaction. Inside the callback, use transactionalEntityManager to run operations like save.

```typescript
import { Provide, Inject } from '@midwayjs/core';
import { TypeORMDataSourceManager } from '@midwayjs/typeorm';
import { UserDTO } from '../entity/user';

@Provide()
export class UserService {

  @Inject()
  dataSourceManager: TypeORMDataSourceManager;

  async updateUser(user: UserDTO) {

    // get dataSource
    const dataSource = this.dataSourceManager.getDataSource('default');

    // start transaction
    await dataSource.transaction(async (transactionalEntityManager) => {
      // run code
      await transactionalEntityManager.save(UserDTO, user);
    });
  }

}
```

--------------------------------

### 启动 docker-compose 服务

Source: https://www.midwayjs.org/docs/3.0.0/extensions/prometheus

使用 docker-compose up 启动 Prometheus 服务，开始拉取 Node 应用的指标数据。

```bash
$ docker-compose up
```

--------------------------------

### Get HTTP server with framework.getServer()

Source: https://www.midwayjs.org/docs/3.0.0/extensions/koa

Retrieves the underlying HTTP server after the server has started by injecting the Koa framework and calling getServer() in the onServerReady lifecycle hook.

```typescript
import { App, Configuration } from '@midwayjs/core';
import * as koa from '@midwayjs/koa';

@Configuration({
	// ...
})
export class MainConfiguration {
  @Inject()
  framework: koa.Framework;

  async onServerReady(container) {
    const server = this.framework.getServer();
    // ...
  }
}
```

--------------------------------

### Define ICacheService interface and implementations

Source: https://www.midwayjs.org/docs/3.0.0/container

Defines an interface and two implementations (local and remote) that a factory method can return. This is the setup for the dynamic factory injection example.

```typescript
export interface  ICacheService {
  getData(): any;
}

@Provide()
export class LocalCacheService implements ICacheService {
  async getData {}
}

@Provide()
export class RemoteCacheService implements ICacheService {
  async getData {}
}
```

--------------------------------

### Get header parameter from context API

Source: https://www.midwayjs.org/docs/3.0.0/controller

Use this snippet to retrieve a request header value via the context object in a MidwayJS controller. The @Inject() decorator injects the Context, and this.ctx.get('cache-control') retrieves the header value. The example shows a GET endpoint that uses the context API.

```typescript
// src/controller/user.ts
// GET /user/1
import { Controller, Get, Inject } from '@midwayjs/core';
import { Context } from '@midwayjs/koa';

@Controller('/user')
export class UserController {

  @Inject()
  ctx: Context;

  @Get('/:uid')
  async getUser(): Promise<User> {
    const cacheSetting = this.ctx.get('cache-control');
    // no-cache
  }
}
```

--------------------------------

### Install @midwayjs/tenant via npm

Source: https://www.midwayjs.org/docs/3.0.0/extensions/tenant

Install the @midwayjs/tenant package version 3 using npm.

```bash
$ npm i @midwayjs/tenant@3 --save
```

--------------------------------

### Install upload dependencies

Source: https://www.midwayjs.org/docs/3.0.0/hooks/upload

Install the required packages for file upload in a Midway Hooks project.

```bash
npm install @midwayjs/upload @midwayjs/hooks-upload
```

--------------------------------

### Hello World API endpoint

Source: https://www.midwayjs.org/docs/3.0.0/hooks/test

Defines a simple GET endpoint at /hello that returns 'Hello World!'. This is the backend code used as the example for testing HTTP interfaces in Midway Hooks.

```typescript
import { Api, Get } from '@midwayjs/hooks';

export default Api(Get('/hello'), async () => {
  return 'Hello World!';
});
```

--------------------------------

### Default public directory structure

Source: https://www.midwayjs.org/docs/3.0.0/extensions/static_file

Example project structure showing the default public directory.

```text
➜  my_midway_app tree
.
├── src
├── public
|   ├── index.html
│   └── hello.js
│
├── test
├── package.json
└── tsconfig.json
```

--------------------------------

### Package.json scripts for mwtsc

Source: https://www.midwayjs.org/docs/3.0.0/tool/mwtsc

Example package.json scripts for Midway projects. The dev script uses mwtsc with --run @midwayjs/mock/app to start the framework locally; the build script uses tsc.

```json
{
  "scripts": {
    "dev": "cross-env NODE_ENV=local mwtsc --watch --run @midwayjs/mock/app",
    "build": "cross-env rm -rf dist && tsc"
  },
}
```

--------------------------------

### Install MikroORM component via npm

Source: https://www.midwayjs.org/docs/3.0.0/extensions/mikro

Install the Midway Mikro component and the MikroORM core package using npm.

```bash
$ npm i @midwayjs/mikro@3 @mikro-orm/core --save
```
Tokens:
Raw