Raised when Graph.hydrate receives a snapshot that does not match the live graph's capabilities — either an unsupported schema version or a schemaHash that diverges from the digest of the currently registered node id-set.

Catches the hydration-mismatch race where the server-snapshot id-set diverges from the client node-set. The check is structural: schemaHash is the persistence-side mirror of Graph.subscribe's narrow-capability discipline, ensuring a stale or malicious snapshot whose id-set diverges from the live graph is rejected up-front rather than silently tearing engine state. The capability check is structural, not a hope.

Discriminator: 'schema-version' rejects an unsupported wire-format version; 'schema-hash' rejects a capability-mismatch on a supported version.

Human-readable diagnostic appended to the message.

Hierarchy (View Summary)

Constructors

Properties

cause?: unknown
detail: string
kind: "HydrationSchema" = ...

Discriminated tag for exhaustive matching.

message: string
name: string = 'HydrationSchemaError'
reason: "schema-version" | "schema-hash"
stack?: string
stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Methods

  • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

    const myObject = {};
    Error.captureStackTrace(myObject);
    myObject.stack; // Similar to `new Error().stack`

    The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

    The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

    The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

    function a() {
    b();
    }

    function b() {
    c();
    }

    function c() {
    // Create an error without stack trace to avoid calculating the stack trace twice.
    const { stackTraceLimit } = Error;
    Error.stackTraceLimit = 0;
    const error = new Error();
    Error.stackTraceLimit = stackTraceLimit;

    // Capture the stack trace above function b
    Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
    throw error;
    }

    a();

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void