PropertyShape | @m-ld/m-ld - v0.10.0

see: ShapeConstrained for using Shapes for schema validation
see: https://www.w3.org/TR/shacl/#property-shapes

Hierarchy

Shape
- PropertyShape

Implements

MeldConstraint

Index

Constructors

constructor

Methods

Constructors

constructor

new PropertyShape(spec?: PropertyShapeSpec): PropertyShape

Overrides OrmSubject.constructor

Parameters
- Optional spec: PropertyShapeSpec
Returns PropertyShape

Methods

affected

affected(_state: MeldReadState, update: GraphUpdate): Promise<GraphUpdate>

Overrides Shape.affected

Updated subjects for a property shape will only contain the single property which matches this property shape's path.

inheritdoc

todo

inverse properties: which subject is returned?

todo

respect targetClass

Parameters
- _state: MeldReadState
- update: GraphUpdate
Returns Promise<GraphUpdate>

apply

apply(state: MeldReadState, interim: InterimUpdate): Promise<ValidationResult[]>

Implementation of MeldConstraint.apply

Overrides Shape.apply

Parameters
- state: MeldReadState
- interim: InterimUpdate
Returns Promise<ValidationResult[]>

check

check(state: MeldReadState, interim: InterimUpdate): Promise<ValidationResult[]>

Implementation of MeldConstraint.check

Overrides Shape.check

Parameters
- state: MeldReadState
- interim: InterimUpdate
Returns Promise<ValidationResult[]>

toString

toString(): string

Returns string

Static declare

declare(spec: PropertyShapeSpec): Subject

Shape declaration. Insert into the domain data to install the shape. For example (assuming a m-ld clone object):
```
clone.write(PropertyShape.declare({ path: 'name', count: 1 }));
```
Parameters
- spec: PropertyShapeSpec
  
  shape specification object
Returns Subject

Static from

from(src: GraphSubject): Shape | Promise<Shape>

Inherited from Shape.from

see

https://www.w3.org/TR/shacl/#terminology

Parameters
- src: GraphSubject
Returns Shape | Promise<Shape>

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.10.0 Source code licensed MIT. Privacy policy