# midway-nacos

> use nacos in midwayjs。

Latest version **3.0.8** (published 2024-09-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install midway-nacos
pnpm add midway-nacos
yarn add midway-nacos
bun add midway-nacos
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.8 |
| Published | 2024-09-12 |
| First published | 2022-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 23.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | larry |
| Maintainers | larryz |
| Keywords | midway, nacos |

## Links

- npm: https://www.npmjs.com/package/midway-nacos
- Repository: https://github.com/larryzhuo/midway-nacos
- Homepage: https://github.com/larryzhuo/midway-nacos#readme
- Issues: https://github.com/larryzhuo/midway-nacos/issues
- npm.io page: https://npm.io/package/midway-nacos

## Dependencies (1)

- [nacos](https://npm.io/package/nacos.md) =2.5.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.0.8 (latest) — 2024-09-12
- 3.0.7 — 2024-05-29
- 3.0.6 — 2024-03-03
- 3.0.5 — 2024-03-01
- 3.0.4 — 2022-11-03
- 3.0.3 — 2022-06-15
- 3.0.2 — 2022-06-09
- 3.0.1 — 2022-06-09
- 3.0.0 — 2022-06-09
- 2.0.0 — 2022-06-09
- 1.0.0 — 2022-06-08

## README

# midway-nacos
use nacos in midwayjs。

这是基于 midway 3.0 的 nacos 组件模块，基于 [nacos模块](https://github.com/nacos-group/nacos-sdk-nodejs) 封装

## 引入组件

首先，引入 组件，在 src/configuration.ts 中导入

```ts
import { Configuration } from '@midwayjs/decorator';
import * as nacos from 'midway-nacos';
import { join } from 'path';

@Configuration({
  imports: [
    // ...
    nacos, // 导入 nacos 组件
  ],
  importConfigs: [join(__dirname, 'config')],
})
export class ContainerLifeCycle {}
```

## 配置

单客户端配置

```ts
// src/config/config.default.ts
export default {
  // ...
  nacos: {
    'registry': {     //注册中心
      client: {     //单实例 https://midwayjs.org/en/docs/service_factory#%E5%8D%95%E4%B8%AA%E5%AE%9E%E4%BE%8B
        serverList: '127.0.0.1:8848', // replace to real nacos serverList
        namespace: 'public',
      }
    },
    'config': {     //配置中心
      client: {
        serverAddr: '127.0.0.1:8848',
      }
    }
  }
};
```

## 使用

```ts
import { NacosNamingFactoryService } from 'midway-nacos';
import { join } from 'path';

@Provide()
export class UserService {
  
  @Inject()
  nacosNamingFactoryService: NacosNamingFactoryService;
  
  async invoke() {
    
    const namingIns = this.nacosNamingFactoryService.get();
    
    let status = await namingIns.getServerStatus();     //namingIns 就是 https://github.com/nacos-group/nacos-sdk-nodejs NacosNamingClient实例

  }
}
```

---
_Source: https://npm.io/package/midway-nacos · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._