Interface FileValidationError

A single referential-integrity error reported by File.validate.

interface FileValidationError {
    code: string;
    hint: string;
    shapeId: string | null;
    pageId: string | null;
}

Properties

code: string

The validation error code (e.g. 'variant-component-bad-name', 'child-not-found').

hint: string

A human-readable description of the error.

shapeId: string | null

The id of the offending shape, when the error is attached to one.

pageId: string | null

The id of the page the offending shape lives in, when applicable.