Skip to content

Type Alias: PropertyGraphValue

@kortexya/reasoninglayer


@kortexya/reasoninglayer / PropertyGraph / PropertyGraphValue

Type Alias: PropertyGraphValue

PropertyGraphValue = OsfqlValue

Defined in: src/types/property-graph.ts:58

A bound value returned by a property-graph query after lowering to OSFQL.

Remarks

An alias of OsfqlValue: the property-graph endpoints return the very same backend DTO (OsfqlValueDto — see bindings: Vec<BTreeMap<String, OsfqlValueDto>> on the Rust PropertyGraphExecuteResponse), because a GQL/Cypher/Gremlin query is lowered to OSFQL and executed by the OSFQL engine. The alias is kept so the property-graph surface reads in its own vocabulary while there remains exactly one definition of the shape.

Uses tagged serialization with a lowercase type discriminator (e.g. {"type": "string", "value": "Alice"}). This is the OSFQL binding value format — not the ValueDto term-CRUD format (which uses PascalCase tags such as {"type": "String", ...}) and not the untagged FeatureValueDto inference format.

The union is recursive: list.value elements and term.value.features entries are themselves values of this shape.

Example

const value: PropertyGraphValue = { type: 'string', value: 'Alice' };
const nothing: PropertyGraphValue = { type: 'null' };
const person: PropertyGraphValue = {
type: 'term',
value: { sort: 'person', features: { name: value } },
};