@metreeca/blue - v0.10.0
    Preparing search index...

    Interface Property<R>

    Shape definition for a resource property.

    Pairs a value range with optional IRI mappings, labels, and visibility flags. Created by the property factory, either explicitly or implicitly when a naked SetShape entry is passed to the resource factory.

    Inheritance

    When a ResourceShape extends a parent via extends, entries with matching keys are merged according to the following rules.

    Field Override Rule
    kind Cannot be overridden
    range Delegated to SetShape merge rules
    hidden Inherited; conflicting parents without child override are reported as an error
    computed Inherited; conflicting parents without child override are reported as an error
    name Cannot be overridden
    description Cannot be overridden
    forward Cannot be overridden
    reverse Cannot be overridden

    SHACL § 2.3 Property Shapes

    interface Property<R extends SetShape = SetShape> {
        kind: "property";
        forward?: string;
        reverse?: string;
        range: R;
        hidden?: boolean;
        computed?: boolean;
        name?: Dictionary;
        description?: Dictionary;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    kind forward? reverse? range hidden? computed? name? description?

    Properties

    kind: "property"

    Discriminator identifying this as a property shape.

    Inheritance — cannot be overridden.

    forward?: string

    The absolute IRI identifying the property for direct mapping.

    Important

    Both forward and reverse mappings write actual property values. This is independent from foreign, which marks a reference as a read-only view over mappings owned by another property.

    Inheritance — cannot be overridden.

    JSON-LD 1.1 § 3.2 IRIs

    reverse?: string

    The absolute IRI identifying the property for inverse mapping.

    Important

    Both forward and reverse mappings write actual property values. This is independent from foreign, which marks a reference as a read-only view over mappings owned by another property.

    Inheritance — cannot be overridden.

    undefined (no inverse mapping)

    JSON-LD 1.1 § 4.8 Reverse Properties

    range: R

    Value range for this property.

    Inheritance — delegated to SetShape merge rules.

    hidden?: boolean

    Excludes the property from default serialisation.

    Inheritance — inherited from parent; conflicting parents without child override are reported as an error.

    undefined (false)

    computed?: boolean

    Marks the property as system-managed.

    Important

    Computed entries are populated by the system and may be silently overwritten on mutation operations. Client-supplied values must still be present in mutation payloads but carry no guarantees of being preserved.

    Inheritance — inherited from parent; conflicting parents without child override are reported as an error.

    undefined (false)

    name?: Dictionary

    Human-readable name for the property.

    Inheritance — cannot be overridden.

    undefined (no label)

    SHACL § 2.3.2.1 sh:name

    description?: Dictionary

    Human-readable description of the property.

    Inheritance — cannot be overridden.

    undefined (no description)

    SHACL § 2.3.2.1 sh:description

    Settings

    Member Visibility

    On This Page

    Properties