Skip to main content

Function: propertyIsRelation()

propertyIsRelation(property): property is { dataType: `Relation(${string})`; knowledgeGraphId: null | string; name: string; optional?: null | boolean; relationType: string }

Defined in: packages/hypergraph/src/mapping/Mapping.ts:173

Parameters​

property​

{ dataType: `Relation(${string})`; knowledgeGraphId: null | string; name: string; optional?: null | boolean; relationType: string; }

dataType​

`Relation(${string})` = SchemaDataTypeRelation

knowledgeGraphId​

null | string = ...

name​

string = EffectSchema.NonEmptyTrimmedString

optional?​

null | boolean = ...

Since

0.4.0

relationType​

string = ...

|

{ dataType: "String" | "Number" | "Boolean" | "Date" | "Point"; knowledgeGraphId: null | string; name: string; optional?: null | boolean; }

dataType​

"String" | "Number" | "Boolean" | "Date" | "Point" = SchemaDataTypePrimitive

knowledgeGraphId​

null | string = ...

name​

string = EffectSchema.NonEmptyTrimmedString

optional?​

null | boolean = ...

Since

0.4.0

Returns​

property is { dataType: `Relation(${string})`; knowledgeGraphId: null | string; name: string; optional?: null | boolean; relationType: string }

Since​

0.2.0