Graphty

Appearance

@graphty/graphty-element / session / RunRecord

Interface: RunRecord ​

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

A frozen, structured-cloneable snapshot of a run.

This is what crosses a worker boundary, what an event carries, what the journal stores and what an export embeds. It holds no functions and no live references, so it can be posted, saved and diffed; Run is the live object, and run.record is this.

Properties ​

algorithm ​

readonly algorithm: AlgorithmKey

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

Which algorithm ran.

caveats ​

readonly caveats: Caveats

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

What qualifies the numbers.

durationMs ​

readonly durationMs: number | null

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

How long it took, in milliseconds, or null until it finishes.

engine ​

readonly engine: EngineVersions

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

Which versions produced the numbers.

fields ​

readonly fields: readonly FieldDescriptor[]

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

The fields the run published.

id ​

readonly id: string

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

The run id.

label ​

readonly label: string

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

What the run is called, computed by the element.

params ​

readonly params: Readonly<Record<string, unknown>>

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

The parameters it ran with, canonicalised.

partial ​

readonly partial: boolean

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

Whether it stopped early and published what it had: true exactly when caveats.partialReason is set.

scope ​

readonly scope: RunScopeRecord

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

The scope it ran over.

seed ​

readonly seed: number | null

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

The seed it used, or null when it needed none.

shape ​

readonly shape: "node-metric" | "edge-metric" | "community" | "layered-grouping" | "category-table" | "path" | "node-set" | "edge-set" | "pair-list" | "temporal" | "fact"

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

The shape, which fixes those field names.

stale ​

readonly stale: StaleNote | null

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

Why its numbers no longer describe what is on screen, when they do not.

startedAt ​

readonly startedAt: string | null

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

When it started, as an ISO 8601 timestamp, or null while it is still queued.

status ​

readonly status: "succeeded" | "failed" | "removed" | "queued" | "running" | "canceled"

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

Where the run got to.

summary? ​

readonly optional summary?: ResultSummary

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

The bounded form of the result, once there is one.