ZenFG TypeScript API / snapshot / root / FrameGraphSnapshotValidationError

Class: FrameGraphSnapshotValidationError

Defined in: packages/snapshot/src/codec.ts:31

Error thrown when a value cannot be serialized as a valid Snapshot 1.2 document.

Decode and parse failures are returned as FrameGraphSnapshotIssue values instead; this error is reserved for producer-side serialization.

Extends

• Error

Constructors

Constructor

new FrameGraphSnapshotValidationError(issues): FrameGraphSnapshotValidationError

Defined in: packages/snapshot/src/codec.ts:32

Parameters

issues

readonly FrameGraphSnapshotIssue[]

All validation failures that prevented serialization.

Returns

FrameGraphSnapshotValidationError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

issues

readonly issues: readonly FrameGraphSnapshotIssue[]

Defined in: packages/snapshot/src/codec.ts:34

All validation failures that prevented serialization.

---

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

Methods

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError