@danqiusheng/nest-nacos 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 丹丘生
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,509 @@
+# nest-nacos 使用文档
+
+> NestJS Nacos 插件 —— 服务发现 + 配置中心，基于 [nacos-sdk-nodejs](https://github.com/nacos-group/nacos-sdk-nodejs)，支持 gRPC 传输协议（Nacos 2.x / 3.x）。
+
+**版本**：v1.0.0 | **License**：MIT
+
+---
+
+## 目录
+
+1. [介绍](#1-介绍)
+2. [安装](#2-安装)
+3. [快速开始](#3-快速开始)
+4. [同步配置 forRoot](#4-同步配置-forroot)
+5. [异步配置 forRootAsync](#5-异步配置-forrootasync)
+6. [服务发现](#6-服务发现)
+7. [配置中心](#7-配置中心)
+8. [装饰器](#8-装饰器)
+9. [健康检查](#9-健康检查)
+10. [API: NacosNamingService](#10-api-nacosnamingservice)
+11. [API: NacosConfigService](#11-api-nacosconfigservice)
+12. [配置项参考](#12-配置项参考)
+13. [常见问题](#13-常见问题)
+
+---
+
+## 1. 介绍
+
+**nest-nacos** 是一个 NestJS 插件，封装了 `nacos-sdk-nodejs`，为 NestJS 应用提供 **服务发现** 和 **配置中心** 能力。基于 gRPC 传输协议，支持 Nacos 2.x / 3.x 服务端。
+
+### 特性
+
+| 特性 | 说明 |
+|------|------|
+| 动态模块 | 支持 `forRoot` / `forRootAsync`，可配合 `@nestjs/config` 从环境变量读取配置 |
+| 自动注册 | 模块初始化时自动注册服务实例，销毁时自动注销，无需手动管理生命周期 |
+| 配置热更新 | 订阅配置变更，服务端实时推送，内置本地缓存与 JSON 解析 |
+| gRPC 传输 | 默认使用 gRPC，服务端实时推送，无需 UDP 端口，支持自动重连 |
+| 装饰器注入 | 提供 `@InjectNacosNaming` / `@InjectNacosConfig` 装饰器，简化依赖注入 |
+| 健康检查 | 内置 `NacosHealthIndicator`，可对接 `@nestjs/terminus` 暴露健康端点 |
+
+### 兼容性
+
+| nest-nacos | nacos-sdk-nodejs | Nacos Server | 传输协议 |
+|---|---|---|---|
+| 1.x | 2.6.x | 3.x / 2.x | gRPC（默认）/ HTTP（仅 2.x） |
+
+---
+
+## 2. 安装
+
+### 步骤 1：安装 nest-nacos 和 nacos SDK
+
+```bash
+# 使用 npm
+npm install nest-nacos nacos
+
+# 使用 yarn
+yarn add nest-nacos nacos
+
+# 使用 pnpm
+pnpm add nest-nacos nacos
+```
+
+### 步骤 2：确保宿主依赖已安装
+
+以下包是 peerDependencies，通常 NestJS 项目中已存在：
+
+```bash
+npm install @nestjs/common @nestjs/core reflect-metadata rxjs
+```
+
+### 步骤 3：（可选）安装配置模块
+
+如果需要从 `.env` 文件读取 Nacos 配置，安装 `@nestjs/config`：
+
+```bash
+npm install @nestjs/config
+```
+
+> **提示**：Nacos Server 版本选择：如果使用 Nacos 3.x，必须使用 gRPC 传输（默认）。HTTP 传输仅支持 Nacos 2.x。
+
+---
+
+## 3. 快速开始
+
+以下是一个最小可用示例，展示如何在 `AppModule` 中同时启用服务发现和配置中心：
+
+```typescript
+import { Module } from '@nestjs/common';
+import { NacosModule } from 'nest-nacos';
+
+@Module({
+  imports: [
+    NacosModule.forRoot({
+      naming: {
+        serverList: '127.0.0.1:8848',
+        username: 'nacos',
+        password: 'nacos',
+      },
+      config: {
+        serverAddr: '127.0.0.1:8848',
+      },
+      instances: [
+        { serviceName: 'order-service', ip: '192.168.1.100', port: 3000 },
+      ],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+应用启动后，nest-nacos 会自动：
+
+- 连接 Nacos 服务端
+- 注册 `order-service` 实例（192.168.1.100:3000）
+- 应用关闭时自动注销该实例
+
+---
+
+## 4. 同步配置 forRoot
+
+适用于配置固定的场景，直接在代码中写入连接参数：
+
+```typescript
+import { NacosModule } from 'nest-nacos';
+
+NacosModule.forRoot({
+  naming: {
+    serverList: '127.0.0.1:8848',
+    namespace: 'production',
+    username: 'nacos',
+    password: 'nacos',
+  },
+  config: {
+    serverAddr: '127.0.0.1:8848',
+    namespace: 'production',
+  },
+  // 启动时自动注册的实例
+  instances: [
+    {
+      serviceName: 'order-service',
+      ip: '192.168.1.100',
+      port: 3000,
+      weight: 1.0,
+      metadata: { version: '1.0.0' },
+    },
+  ],
+  // 启动时预订阅的配置项
+  subscribeConfigs: [
+    { dataId: 'database.yaml', group: 'DEFAULT_GROUP' },
+    { dataId: 'redis.yaml', group: 'DEFAULT_GROUP' },
+  ],
+})
+```
+
+---
+
+## 5. 异步配置 forRootAsync
+
+适用于生产环境，配合 `@nestjs/config` 从环境变量或配置文件读取参数：
+
+```typescript
+import { Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { NacosModule } from 'nest-nacos';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({ isGlobal: true }),
+    NacosModule.forRootAsync({
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: (config: ConfigService) => ({
+        naming: {
+          serverList: config.get('NACOS_SERVER_ADDR'),
+          namespace: config.get('NACOS_NAMESPACE'),
+          username: config.get('NACOS_USERNAME'),
+          password: config.get('NACOS_PASSWORD'),
+        },
+        config: {
+          serverAddr: config.get('NACOS_SERVER_ADDR'),
+          namespace: config.get('NACOS_NAMESPACE'),
+        },
+        instances: [
+          {
+            serviceName: config.get('SERVICE_NAME'),
+            ip: config.get('SERVICE_IP'),
+            port: config.get<number>('SERVICE_PORT'),
+          },
+        ],
+      }),
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+对应的 `.env` 文件：
+
+```env
+NACOS_SERVER_ADDR=127.0.0.1:8848
+NACOS_NAMESPACE=public
+NACOS_USERNAME=nacos
+NACOS_PASSWORD=nacos
+SERVICE_NAME=order-service
+SERVICE_IP=192.168.1.100
+SERVICE_PORT=3000
+```
+
+> **说明**：`forRootAsync` 还支持 `useClass` 和 `useExisting` 两种方式，适合需要从远程配置中心或数据库读取 Nacos 连接参数的场景。
+
+---
+
+## 6. 服务发现
+
+注入 `NacosNamingService` 即可使用服务注册与发现功能：
+
+```typescript
+import { Injectable, OnModuleInit } from '@nestjs/common';
+import { NacosNamingService, InjectNacosNaming } from 'nest-nacos';
+
+@Injectable()
+export class RpcService implements OnModuleInit {
+  @InjectNacosNaming()
+  private readonly naming: NacosNamingService;
+
+  async onModuleInit() {
+    // 订阅 user-service 实例变更（服务端推送）
+    this.naming.subscribe('user-service', (hosts) => {
+      console.log(`user-service 实例数: ${hosts.length}`);
+    });
+  }
+
+  // 查询健康实例并调用
+  async callUserService() {
+    const instances = await this.naming.selectInstances('user-service');
+    if (instances.length === 0) {
+      throw new Error('user-service 无可用实例');
+    }
+    const target = instances[0];
+    return `http://${target.ip}:${target.port}`;
+  }
+
+  // 运行时动态注册新实例
+  async registerTemp() {
+    await this.naming.register({
+      serviceName: 'temp-service',
+      ip: '10.0.0.5',
+      port: 8080,
+      ephemeral: true,
+    });
+  }
+}
+```
+
+---
+
+## 7. 配置中心
+
+注入 `NacosConfigService` 即可读取和订阅配置：
+
+```typescript
+import { Injectable, OnModuleInit } from '@nestjs/common';
+import { NacosConfigService, InjectNacosConfig } from 'nest-nacos';
+
+@Injectable()
+export class DbService implements OnModuleInit {
+  @InjectNacosConfig()
+  private readonly nacosConfig: NacosConfigService;
+
+  private dbConfig: any;
+
+  async onModuleInit() {
+    // 1. 读取配置（自动解析 JSON）
+    this.dbConfig = await this.nacosConfig.getConfigAsJson('database.yaml');
+
+    // 2. 订阅配置热更新
+    this.nacosConfig.subscribe('database.yaml', 'DEFAULT_GROUP', (content) => {
+      this.dbConfig = JSON.parse(content);
+      console.log('数据库配置已热更新');
+    });
+  }
+
+  async updateConfig() {
+    // 发布新配置
+    await this.nacosConfig.publish(
+      'database.yaml',
+      'DEFAULT_GROUP',
+      JSON.stringify({ host: '10.0.0.1', port: 3306 }),
+    );
+  }
+}
+```
+
+> **缓存机制**：`getConfig()` 首次从 Nacos 拉取后会缓存到内存，后续调用直接返回缓存值。订阅配置变更时会自动更新缓存，无需手动管理。
+
+---
+
+## 8. 装饰器
+
+nest-nacos 提供四个装饰器简化依赖注入：
+
+| 装饰器 | 注入对象 | 说明 |
+|--------|----------|------|
+| `@InjectNacosNaming()` | `NacosNamingService` | 注入封装后的 Naming 服务 |
+| `@InjectNacosConfig()` | `NacosConfigService` | 注入封装后的 Config 服务 |
+| `@InjectNacosNamingClient()` | `NacosNamingClient` | 注入原始 SDK 客户端（高级用法） |
+| `@InjectNacosConfigClient()` | `NacosConfigClient` | 注入原始 SDK 客户端（高级用法） |
+
+使用示例：
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import {
+  NacosNamingService,
+  NacosConfigService,
+  InjectNacosNaming,
+  InjectNacosConfig,
+} from 'nest-nacos';
+
+@Injectable()
+export class MyService {
+  @InjectNacosNaming()
+  private readonly naming: NacosNamingService;
+
+  @InjectNacosConfig()
+  private readonly config: NacosConfigService;
+
+  // 也可以用构造函数注入
+  constructor(
+    private readonly naming2: NacosNamingService,
+    private readonly config2: NacosConfigService,
+  ) {}
+}
+```
+
+---
+
+## 9. 健康检查
+
+内置 `NacosHealthIndicator` 可对接 `@nestjs/terminus`：
+
+```typescript
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheckService } from '@nestjs/terminus';
+import { NacosHealthIndicator } from 'nest-nacos';
+
+@Controller('health')
+export class HealthController {
+  constructor(
+    private health: HealthCheckService,
+    private nacos: NacosHealthIndicator,
+  ) {}
+
+  @Get()
+  check() {
+    return this.health.check([
+      () => this.nacos.isHealthy(),
+    ]);
+  }
+}
+```
+
+如果未安装 `@nestjs/terminus`，也可直接调用 `isHealthy()` 方法，返回 `{ status: 'up' | 'down' }`。
+
+---
+
+## 10. API: NacosNamingService
+
+| 方法 | 参数 | 返回值 | 说明 |
+|------|------|--------|------|
+| `register(inst)` | `NacosInstanceOptions` | `Promise<void>` | 注册服务实例 |
+| `deregister(inst)` | `NacosInstanceOptions` | `Promise<void>` | 注销服务实例 |
+| `getAllInstances(serviceName, groupName?, clusters?, subscribe?)` | `string, ...` | `Promise<Host[]>` | 查询所有实例 |
+| `selectInstances(serviceName, groupName?, clusters?, healthy?, subscribe?)` | `string, ...` | `Promise<Host[]>` | 查询健康实例 |
+| `subscribe(info, listener)` | `string \| SubscribeInfo, Function` | `void` | 订阅实例变更推送 |
+| `unSubscribe(info, listener?)` | `string \| SubscribeInfo, Function?` | `void` | 取消订阅 |
+| `getServerStatus()` | 无 | `'UP' \| 'DOWN'` | 获取服务端状态 |
+| `getRawClient()` | 无 | `NacosNamingClient \| null` | 获取原始 SDK 客户端 |
+
+### subscribe 参数说明
+
+`info` 参数支持两种形式：
+
+```typescript
+// 形式一：字符串（serviceName）
+naming.subscribe('user-service', (hosts) => { ... });
+
+// 形式二：对象（可指定分组和集群）
+naming.subscribe(
+  { serviceName: 'user-service', groupName: 'PROD_GROUP', clusters: 'BJ' },
+  (hosts) => { ... },
+);
+```
+
+---
+
+## 11. API: NacosConfigService
+
+| 方法 | 参数 | 返回值 | 说明 |
+|------|------|--------|------|
+| `getConfig(dataId, group?)` | `string, string?` | `Promise<string>` | 获取配置内容（带缓存） |
+| `getConfigAsJson<T>(dataId, group?)` | `string, string?` | `Promise<T>` | 获取配置并解析为 JSON |
+| `publish(dataId, group, content)` | `string, string, string` | `Promise<boolean>` | 发布配置 |
+| `remove(dataId, group)` | `string, string` | `Promise<boolean>` | 删除配置 |
+| `subscribe(dataId, group, listener)` | `string, string, Function` | `void` | 订阅配置变更推送 |
+| `unSubscribe(dataId, group, listener?)` | `string, string, Function?` | `void` | 取消订阅 |
+| `getRawClient()` | 无 | `NacosConfigClient \| null` | 获取原始 SDK 客户端 |
+
+> **默认 group**：`getConfig()` 和 `getConfigAsJson()` 的 `group` 参数默认值为 `'DEFAULT_GROUP'`，如果配置在默认分组下可省略。
+
+---
+
+## 12. 配置项参考
+
+### NacosModuleOptions
+
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `naming` | `NacosNamingOptions` | 否 | Naming 服务发现配置，不传则不启用 |
+| `config` | `NacosConfigOptions` | 否 | Config 配置中心配置，不传则不启用 |
+| `instances` | `NacosInstanceOptions[]` | 否 | 启动时自动注册的服务实例列表 |
+| `subscribeConfigs` | `{ dataId, group }[]` | 否 | 启动时预订阅的配置项列表 |
+
+### NacosNamingOptions
+
+| 字段 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `serverList` | `string \| string[]` | - | Nacos 服务端地址 |
+| `namespace` | `string` | `'public'` | 命名空间 ID |
+| `transport` | `'grpc' \| 'http'` | `'grpc'` | 传输协议 |
+| `username` | `string` | - | 用户名 |
+| `password` | `string` | - | 密码 |
+| `ssl` | `boolean` | `false` | 是否启用 TLS/SSL |
+| `ak` | `string` | - | 阿里云 RAM AccessKey |
+| `sk` | `string` | - | 阿里云 RAM SecretKey |
+| `appName` | `string` | - | 应用名 |
+
+### NacosConfigOptions
+
+| 字段 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `serverAddr` | `string \| string[]` | - | Nacos 服务端地址 |
+| `namespace` | `string` | `'public'` | 命名空间 ID |
+| `transport` | `'grpc' \| 'http'` | `'grpc'` | 传输协议 |
+| `username` | `string` | - | 用户名 |
+| `password` | `string` | - | 密码 |
+| `ssl` | `boolean` | `false` | 是否启用 TLS/SSL |
+| `accessKey` | `string` | - | 阿里云 RAM AccessKey |
+| `secretKey` | `string` | - | 阿里云 RAM SecretKey |
+| `signatureRegionId` | `string` | - | v4 签名区域 ID |
+
+### NacosInstanceOptions
+
+| 字段 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `serviceName` | `string` | - | 服务名 |
+| `ip` | `string` | - | 实例 IP |
+| `port` | `number` | - | 实例端口 |
+| `weight` | `number` | `1.0` | 权重 |
+| `ephemeral` | `boolean` | `true` | 是否临时实例 |
+| `clusterName` | `string` | - | 集群名 |
+| `groupName` | `string` | `'DEFAULT_GROUP'` | 分组名 |
+| `metadata` | `Record<string, string>` | - | 元数据 |
+
+---
+
+## 13. 常见问题
+
+### 只启用配置中心，不启用服务发现可以吗？
+
+可以。`naming` 和 `config` 都是可选的，只传 `config` 即可：
+
+```typescript
+NacosModule.forRoot({
+  config: { serverAddr: '127.0.0.1:8848' },
+  // 不传 naming，NacosNamingService 注入后客户端为 null
+})
+```
+
+此时 `NacosNamingService` 仍可注入，但调用其方法会抛出 `NacosNamingClient 未初始化` 错误。
+
+### 如何选择 gRPC 还是 HTTP 传输？
+
+| 传输协议 | Nacos 2.x | Nacos 3.x | 推荐场景 |
+|----------|-----------|-----------|----------|
+| `grpc`（默认） | 支持 | 支持 | 推荐，实时推送，无需 UDP |
+| `http` | 支持 | 不支持 | 仅兼容旧版 Nacos 2.x 时使用 |
+
+### Nacos 3.x 连接失败怎么办？
+
+Nacos 3.x 已移除 HTTP API 支持，必须使用 gRPC 传输（默认）。确保：
+
+- 未设置 `transport: 'http'`
+- Nacos Server 的 gRPC 端口（默认 9848，即 serverPort + 1000）已开放
+- 检查用户名密码是否正确
+
+### 配置更新后业务代码没有生效？
+
+确保通过 `subscribe()` 订阅了配置变更，并在回调中更新本地变量。`getConfig()` 返回的是缓存值，订阅后缓存会自动更新，但业务代码中引用的变量需要手动更新。
+
+### 如何获取原始 SDK 客户端？
+
+使用 `getRawClient()` 方法或 `@InjectNacosNamingClient()` / `@InjectNacosConfigClient()` 装饰器获取原始 `NacosNamingClient` / `NacosConfigClient` 实例，调用 SDK 未封装的高级 API。
+
+---
+
+*nest-nacos v1.0.0 · MIT License · 基于 nacos-sdk-nodejs v2.6.x*

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * NestJS Nacos 插件 - 统一导出
+ *
+ * @packageDocumentation
+ */
+export * from './nacos.constants';
+export * from './nacos.interfaces';
+export * from './nacos.module';
+export * from './nacos.providers';
+export * from './nacos-naming.service';
+export * from './nacos-config.service';
+export * from './nacos.decorators';
+export * from './nacos.health';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * NestJS Nacos 插件 - 统一导出
+ *
+ * @packageDocumentation
+ */
+__exportStar(require("./nacos.constants"), exports);
+__exportStar(require("./nacos.interfaces"), exports);
+__exportStar(require("./nacos.module"), exports);
+__exportStar(require("./nacos.providers"), exports);
+__exportStar(require("./nacos-naming.service"), exports);
+__exportStar(require("./nacos-config.service"), exports);
+__exportStar(require("./nacos.decorators"), exports);
+__exportStar(require("./nacos.health"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;GAIG;AACH,oDAAkC;AAClC,qDAAmC;AACnC,iDAA+B;AAC/B,oDAAkC;AAClC,yDAAuC;AACvC,yDAAuC;AACvC,qDAAmC;AACnC,iDAA+B"}

package/dist/nacos-config.service.d.ts

@@ -0,0 +1,62 @@
+/**
+ * NestJS Nacos 插件 - Config 服务（配置中心）
+ *
+ * 封装 NacosConfigClient，负责：
+ * - 配置读取与发布
+ * - 配置变更订阅（服务端推送）
+ * - 本地配置缓存（支持热更新）
+ */
+import { OnModuleDestroy, OnModuleInit } from '@nestjs/common';
+import { NacosConfigClient } from 'nacos';
+import { NacosModuleOptions } from './nacos.interfaces';
+export declare class NacosConfigService implements OnModuleInit, OnModuleDestroy {
+    private readonly client;
+    private readonly options;
+    private readonly logger;
+    /** 配置缓存：key = `${dataId}@@${group}` */
+    private readonly cache;
+    /** 订阅回调集合：key = `${dataId}@@${group}` */
+    private readonly listeners;
+    constructor(client: NacosConfigClient | null, options: NacosModuleOptions | null);
+    /** 模块初始化：等待客户端就绪 + 预加载订阅配置 */
+    onModuleInit(): Promise<void>;
+    onModuleDestroy(): Promise<void>;
+    /**
+     * 获取配置内容
+     * @param dataId 配置 ID
+     * @param group 分组名，默认 'DEFAULT_GROUP'
+     * @returns 配置内容字符串
+     */
+    getConfig(dataId: string, group?: string): Promise<string>;
+    /**
+     * 获取配置并解析为 JSON 对象
+     */
+    getConfigAsJson<T = any>(dataId: string, group?: string): Promise<T>;
+    /**
+     * 发布配置
+     * @param dataId 配置 ID
+     * @param group 分组名
+     * @param content 配置内容
+     */
+    publish(dataId: string, group: string, content: string): Promise<boolean>;
+    /**
+     * 删除配置
+     */
+    remove(dataId: string, group: string): Promise<boolean>;
+    /**
+     * 订阅配置变更（服务端推送）
+     * @param dataId 配置 ID
+     * @param group 分组名
+     * @param listener 回调函数，参数为新配置内容
+     */
+    subscribe(dataId: string, group: string, listener: (content: string) => void): void;
+    /**
+     * 取消订阅
+     */
+    unSubscribe(dataId: string, group: string, listener?: (content: string) => void): void;
+    /** 获取原始客户端 */
+    getRawClient(): NacosConfigClient | null;
+    /** 内部方法：加载配置并建立订阅 */
+    private loadAndSubscribe;
+}
+//# sourceMappingURL=nacos-config.service.d.ts.map

package/dist/nacos-config.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nacos-config.service.d.ts","sourceRoot":"","sources":["../src/nacos-config.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAA8B,eAAe,EAAE,YAAY,EAAY,MAAM,gBAAgB,CAAC;AACrG,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,qBACa,kBAAmB,YAAW,YAAY,EAAE,eAAe;IAQ3B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR7D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAuC;IAC9D,uCAAuC;IACvC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;IACnD,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqD;gBAGnB,MAAM,EAAE,iBAAiB,GAAG,IAAI,EACtC,OAAO,EAAE,kBAAkB,GAAG,IAAI;IAGxF,8BAA8B;IACxB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAe7B,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtC;;;;;OAKG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,SAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAWzE;;OAEG;IACG,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,SAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAUnF;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS/E;;OAEG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS7D;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAiBnF;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAYtF,cAAc;IACd,YAAY,IAAI,iBAAiB,GAAG,IAAI;IAIxC,qBAAqB;YACP,gBAAgB;CAY/B"}