跳到主要内容

rxdb-client-generator

RxDB 客户端代码生成器,用于从实体定义自动生成 TypeScript 客户端代码。

安装

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'
})
]
};

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-