@grest-ts/discovery

中文文档
0.0.101发布于 2026/11/02MITTypeScriptES Module零依赖近 30 天下载 5518

Service discovery implementations for Grest Framework

原始使用文档
文档目录5 节
  1. Exports
  2. GGDiscoveryClient (abstract class)
  3. GG_DISCOVERY (locator key)
  4. GGServiceRegistration (interface)
  5. Implementations

Part of the grest-ts framework. Documentation | All packages

@grest-ts/discovery

Base package for service discovery in grest-ts. Provides the abstract class, types, and locator key that all discovery implementations build on.

For a full overview of how discovery works and available implementations, see the Discovery guide.

Exports

GGDiscoveryClient (abstract class)

The base class all discovery implementations extend:

abstract class GGDiscoveryClient {
    readonly isLocal: boolean = false;

    abstract registerRoutes(registrations: GGServiceRegistration[]): void;
    abstract register(): Promise<void>;
    abstract unregister(): Promise<void>;
    abstract discoverApi(apiName: string): Promise<string>;
}
MethodPurpose
registerRoutes()Called when an HTTP server starts. Tells discovery what APIs this service provides.
register()Registers the service with the discovery backend.
unregister()Cleans up on shutdown.
discoverApi()Returns the full URL for a given API name. This is what clients call.

The isLocal flag indicates local development mode. When true, cloud resources (AWS SNS, etc.) should use local adapters instead.

GG_DISCOVERY (locator key)

const GG_DISCOVERY = new GGLocatorKey<GGDiscoveryClient>("GGDiscovery");

Service locator key for registering and accessing the active discovery client.

GGServiceRegistration (interface)

interface GGServiceRegistration {
    runtime: string;       // Service name
    api: string;           // API name, e.g. "UserApi"
    protocol: "http" | "ws";
    port: number;
    pathPrefix: string;    // e.g. "/api/users/"
}

Implementations

PackageUse case
@grest-ts/discovery-staticProduction deployments with known URLs
@grest-ts/discovery-localLocal development and testing
@grest-ts/discovery-kubernetesKubernetes deployments
@grest-ts/discovery-migrationZero-downtime migration between strategies

For local development the router can also be launched standalone with npx @grest-ts/discovery-local --port 9000 — runtimes then connect as plain GGLocalDiscoveryClients instead of the default leader-elected GGLocalDiscoveryResilientClient.

版本与发布记录

@grest-ts/discovery 共发布 84 个版本,首次发布于 2026/02/24;过去 12 个月发布了 84 个版本。

版本发布日期距今
0.0.101latest2026/11/0214 天前
0.0.1002026/10/3017 天前
0.0.992026/10/3018 天前
0.0.982026/10/2820 天前
0.0.972026/10/2720 天前
0.0.962026/10/2721 天前

关于 @grest-ts/discovery 的常见问题

@grest-ts/discovery 是什么?

Service discovery implementations for Grest Framework

如何安装 @grest-ts/discovery?

在项目目录运行 npm install @grest-ts/discovery,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@grest-ts/locator(0.0.101)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@grest-ts/discovery 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@grest-ts/discovery 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@grest-ts/discovery 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@grest-ts/discovery 可以商用吗?

@grest-ts/discovery 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@grest-ts/discovery 的下载量有多少?

根据 npm 官方下载统计,@grest-ts/discovery 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,518 次,日均约 184 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@grest-ts/discovery 还在维护吗?

最新版本 0.0.101 发布于 2026/11/02(14 天前);至今共发布 84 个版本,其中过去 12 个月发布了 84 个;首次发布于 2026/02/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。