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

    Interface PropertyConstraints<R>

    Constraints for property shape factories.

    When neither forward nor reverse is explicitly defined, a default forward IRI is generated by resolving the property name against the effective namespace, determined in this order:

    1. The shape's own ResourceConstraints.namespace
    2. The common inherited namespace from parent shapes
    3. The default defaultNamespace namespace

    SHACL § 2.3 Property Shapes

    interface PropertyConstraints<R extends SetShape = SetShape> {
        kind?: "property";
        range?: R;
        hidden?: boolean;
        computed?: boolean;
        name?: Dictionary;
        description?: Dictionary;
        forward?: string | { "": string; readonly [term: string]: string };
        reverse?: string | { "": string; readonly [term: string]: string };
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    kind?: "property"

    Discriminator identifying the value produced by the property factory.

    Absent from a bare constraints argument; set to "property" on the factory's result so Range can tell a property entry from a naked SetShape.

    range?: R

    Value range for this property.

    Absent from a bare constraints argument; carried on the factory's result to thread the range type. Computed by the resource factory from the entries. 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

    forward?: string | { "": string; readonly [term: string]: string }

    The absolute IRI identifying the property for direct mapping.

    Accepts either an absolute IRI string or a Namespace function that resolves the property name to an absolute IRI (for instance, { forward: schema } on property name yields http://schema.org/name).

    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 | { "": string; readonly [term: string]: string }

    The absolute IRI identifying the property for inverse mapping.

    Accepts either an absolute IRI string or a Namespace function that resolves the property name to an absolute IRI (for instance, { reverse: schema } on property employee yields http://schema.org/employee).

    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

    Settings

    Member Visibility

    On This Page

    Properties