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

    Interface Property<R>

    Shape definition for a resource property.

    SHACL § 2.3.2 Property Shapes

    interface Property<R extends Range = Range> {
        kind: "property";
        range: R;
        hidden?: boolean;
        name?: Local;
        description?: Local;
        forward?: string | Namespace;
        reverse?: string | Namespace;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    kind: "property"

    Discriminator identifying this as a property shape.

    range: R

    Value range for this property.

    hidden?: boolean

    Excludes the property from default serialization.

    undefined (false)

    name?: Local

    Human-readable name for the property.

    undefined (no label)

    SHACL § 6.1.1 sh:name

    description?: Local

    Human-readable description of the property.

    undefined (no description)

    SHACL § 6.1.2 sh:description

    forward?: string | Namespace

    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).

    JSON-LD 1.1 § 3.2 IRIs

    reverse?: string | Namespace

    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).

    undefined (no inverse mapping)

    JSON-LD 1.1 § 4.8 Reverse Properties

    Settings

    Member Visibility

    On This Page

    Properties