跳到主要内容

generateEntityRules()

function generateEntityRules(
generator,
metadata,
firstMetadata?,
ignoreKeys?,
result?,
patch?
): RuleTypeData[];

Defined in: generators/entity-rules.ts:288

递归收集一个实体(含外键与关系对端)的全部查询规则。

Parameters​

ParameterTypeDefault valueDescription
generatorRxDBClientGeneratorundefined持有全部实体元数据的生成器实例,用于解析关系对端
metadataEntityMetadataundefined当前递归层级的实体元数据
firstMetadata?Readonly<EntityMetadataType>undefined递归起点的实体元数据,缺省时取 metadata
ignoreKeys?string[][]本层需要跳过的属性名,避免关系回环重复展开
result?RuleTypeData[][]累积结果数组,递归时透传
patch?PatchData[][]从递归起点到当前层的路径片段,用于拼出 a.b.c 形式的规则键

Returns​

RuleTypeData[]

累积后的规则数组(与传入的 result 是同一个引用)

Example​

const rules = generateEntityRules(generator, metadata);