Graphty

Appearance

@graphty/graphty-element / session / SessionRunsOptions

Interface: SessionRunsOptions ​

Defined in: graphty-element/src/session/types.ts:2139

How a session runs algorithms.

execute is the one member without a default, and the reason is worth stating: every algorithm this package ships is constructed from the renderer's Graph and reads the graph through its data manager, so the session -- which must resolve in Node with no renderer anywhere in its import graph -- cannot reach one. The element builds the executor and hands it in. A session built without one answers runs.start with E_UNSUPPORTED rather than pretending.

Properties ​

calibration? ​

readonly optional calibration?: () => MachineCalibration | undefined

Defined in: graphty-element/src/session/types.ts:2160

Reads this machine's measured throughput, when the host has measured it.

Returns ​

MachineCalibration | undefined

defaultCaveats? ​

readonly optional defaultCaveats?: Caveats

Defined in: graphty-element/src/session/types.ts:2156

The caveats a run starts from, before the work refines them.

defaultScope? ​

readonly optional defaultScope?: Scope

Defined in: graphty-element/src/session/types.ts:2154

What a call that names no scope gets. Defaults to the visible graph.

engine? ​

readonly optional engine?: EngineVersions

Defined in: graphty-element/src/session/types.ts:2152

Which versions are producing the numbers. Defaults to the element's own.

execute? ​

readonly optional execute?: RunExecutor

Defined in: graphty-element/src/session/types.ts:2143

The thing that actually runs an algorithm. Absent means this session cannot run one.

limits? ​

readonly optional limits?: Readonly<CostGateLimits>

Defined in: graphty-element/src/session/types.ts:2158

The cap and the memory budget the cost gate compares a run against.

measurements? ​

readonly optional measurements?: () => ReadonlyMap<AlgorithmKey, CostMeasurement> | undefined

Defined in: graphty-element/src/session/types.ts:2162

Reads the most recent timing of each algorithm on this machine.

Returns ​

ReadonlyMap<AlgorithmKey, CostMeasurement> | undefined

queue? ​

readonly optional queue?: RunQueue

Defined in: graphty-element/src/session/types.ts:2150

The queue runs take their turn in. Absent builds a sequential one of the session's own, which is right for a headless session and wrong for a rendered graph: a rendered graph has loads, layouts and style passes that must not interleave with a run, and it hands in the element's own operation queue so that they do not.