跳到主要内容

rxdb-client-generator

RxDB 客户端代码生成器,从实体定义自动生成类型安全的 TypeScript 客户端代码。

功能特性

  • 代码生成: 自动生成 CRUD 操作代码
  • 类型安全: 完整的 TypeScript 类型推断
  • Vite 集成: 支持 Vite 插件方式
  • CLI 支持: 支持命令行方式

安装

npm install @aiao/rxdb-client-generator
# 或
pnpm add @aiao/rxdb-client-generator

使用

CLI

rxdb-client-generator ./rxdb.config.ts

Vite 插件

import { rxdbClientGeneratorVitePlugin } from '@aiao/rxdb-client-generator/vite';

export default {
plugins: [
rxdbClientGeneratorVitePlugin({
entities: ['./src/entities/**/*.ts'],
outDir: './src/generated'
})
]
};

Fileoverview

RxDB Client Generator RxDB 客户端代码生成器,从实体元数据生成类型定义和实体类代码

主要功能:

  • 从 EntityMetadata 生成 .d.ts 类型定义文件
  • 生成实体类的 .js 文件(使用装饰器)
  • 支持分文件(splitFiles)和单文件两种生成模式
  • 支持 TreeRepository 等扩展 Repository 类型

Classes

ClassDescription
RepositoryGeneratorBase基础 Repository 生成器(抽象基类) 提供通用工具方法,子类继承后生成各自的 Repository 属性和方法
RxDBClientGeneratorRxDB Client 生成器

Interfaces

InterfaceDescription
GeneratorContextGenerator 上下文 包含生成属性和方法所需的所有上下文信息
IRepositoryGeneratorRepository 生成器接口
RxDBClientGeneratorOptions-
SourceFile源文件接口

Variables

VariableDescription
NAMESPACE_PUBLIC-
REPOSITORY_TYPE_GRAPH_REPOSITORY-
REPOSITORY_TYPE_REPOSITORY-
REPOSITORY_TYPE_TREE_REPOSITORY-