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

    Interface Id

    Shape definition for the resource identifier property.

    Tags a resource property as mapping to JSON-LD @id. Created by the id factory. At most one id entry is allowed per resource shape, counted after inheritance merging: declarations sharing a property name collapse into a single entry, so an entry reaching the shape through several parents or redeclared by the shape counts once, while two id entries under distinct names are rejected.

    Important

    Rejected on embedded resource shapes during state validation, as embedded resources have no independent identity; the rejection surfaces when a nested resource state is checked, not at shape construction, since an id-bearing embedded range is indistinguishable from an expanded captive reference until then. A standalone reference target carries its own identifier and is unaffected.

    Inheritance

    When a ResourceShape extends a parent via extends, identifier entries are subject to the following rules.

    Field Override Rule
    kind Cannot be overridden
    hidden Taken from the most derived declaration; among sibling parents, from the first declared
    interface Id {
        kind: "id";
        hidden?: boolean;
    }
    Index

    Properties

    Properties

    kind: "id"

    Discriminator identifying this as a resource identifier property.

    Inheritance — cannot be overridden.

    hidden?: boolean

    Excludes the property from default serialisation.

    Inheritance — taken from the most derived declaration; among sibling parents, from the first declared.

    undefined (false)