RxDBClientGenerator

Defined in: core/RxDBClientGenerator.ts:57

RxDB Client 生成器

Constructors

Constructor

new RxDBClientGenerator(options?): RxDBClientGenerator;

Defined in: core/RxDBClientGenerator.ts:79

Parameters

Parameter	Type
options?	RxDBClientGeneratorOptions

Returns

RxDBClientGenerator

Properties

config

config: Required<RxDBClientGeneratorOptions>;

Defined in: core/RxDBClientGenerator.ts:74

---

entityMetadataOptionsMap

entityMetadataOptionsMap: Map<string, EntityMetadataOptions[]>;

Defined in: core/RxDBClientGenerator.ts:64

---

metadataMap

metadataMap: Map<string, Readonly<EntityMetadataType>>;

Defined in: core/RxDBClientGenerator.ts:71

---

metadataOptionsSet

metadataOptionsSet: Set<EntityMetadataOptions>;

Defined in: core/RxDBClientGenerator.ts:69

---

metadataSet

metadataSet: Set<Readonly<EntityMetadataType>>;

Defined in: core/RxDBClientGenerator.ts:70

---

project

project: Project;

Defined in: core/RxDBClientGenerator.ts:72

Methods

addEntity()

addEntity(value, options?): void;

Defined in: core/RxDBClientGenerator.ts:92

添加实体配置

Parameters

Parameter	Type	Description
value	| EntityMetadataOptions | EntityType	实体
options?	EntityMetadataOptions[]	-

Returns

void

---

exec()

exec(): void;

Defined in: core/RxDBClientGenerator.ts:146

执行生成器

Returns

void

---

generateEntityJsFile()

generateEntityJsFile(): void;

Defined in: core/RxDBClientGenerator.ts:160

生成实体的 js 文件 公开此方法以便测试使用

Returns

void

---

getMetadata()

getMetadata(mappedEntity, mappedNamespace): Readonly<EntityMetadataType> | undefined;

Defined in: core/RxDBClientGenerator.ts:107

Parameters

Parameter	Type
mappedEntity	string
mappedNamespace	string

Returns

Readonly<EntityMetadataType> | undefined

---

getRepositoryGenerator()

getRepositoryGenerator(name): 
  | IRepositoryGenerator
  | undefined;

Defined in: core/RxDBClientGenerator.ts:139

获取 Repository 生成器

Parameters

Parameter	Type	Description
name	string	Repository 名称

Returns

| IRepositoryGenerator | undefined

对应的生成器，如果不存在则返回 undefined

---

getSourceFiles()

getSourceFiles(): SourceFile[];

Defined in: core/RxDBClientGenerator.ts:152

Returns

SourceFile[]

---

registerAbstractMetadata()

registerAbstractMetadata(abstractEntityName, metadataOptions): void;

Defined in: core/RxDBClientGenerator.ts:111

Parameters

Parameter	Type
abstractEntityName	string
metadataOptions	EntityMetadataOptions[]

Returns

void

---

registerRepositoryGenerator()

registerRepositoryGenerator(generator): void;

Defined in: core/RxDBClientGenerator.ts:130

注册 Repository 生成器 用于扩展支持自定义 Repository 类型

Parameters

Parameter	Type	Description
generator	IRepositoryGenerator	Repository 生成器实例

Returns

void

Example

const generator = new RxDBClientGenerator();
generator.registerRepositoryGenerator(new GeoRepositoryGenerator());