API Reference

restoreGraph()

Restore a graph instance from a checkpoint and restore registry.

Import

import { restoreGraph } from "@graphrefly/ts/graph";

Signature

function restoreGraph(
	checkpoint: GraphCheckpoint,
	options: RestoreGraphOptions,
): Graph

Parameters

Parameter	Type	Description
`checkpoint`	`GraphCheckpoint`	Serialized graph checkpoint to restore.
`options`	`RestoreGraphOptions`	Restore registry and optional dispatcher/versioning overrides.

Returns

A live graph rebuilt from the checkpoint.

Example

import { defaultRestoreRegistry, graph, restoreGraph } from "@graphrefly/ts/graph";

const original = graph();
const restored = restoreGraph(original.checkpoint(), { registry: defaultRestoreRegistry });

Source

packages/ts/src/graph/restore.ts