API Reference

attachObserveEventLog()

Persist Graph.observe() events to an append log. This is a graph-bound adapter over passive storage frames, not graph restore or projection.

Import

import { attachObserveEventLog } from "@graphrefly/ts/adapters/observe-storage";

Signature

function attachObserveEventLog(
	graph: Graph,
	log: AppendLogStorageTier<ObserveEventFrame<T>>,
	opts: AttachObserveEventLogOptions<T> = {},
): ObserveEventLogHandle

Parameters

Parameter	Type	Description
`graph`	`Graph`	Graph that owns the created nodes or projector.
`log`	`AppendLogStorageTier<ObserveEventFrame<T>>`	log value used by the helper.
`opts`	`AttachObserveEventLogOptions<T>`	Options that configure the helper.

Returns

A ObserveEventLogHandle value.

Example

import { attachObserveEventLog } from "@graphrefly/ts/adapters/observe-storage";

Source

packages/ts/src/adapters/observe-storage.ts