@graphty/graph-io / positions / PositionNote

Interface: PositionNote

Defined in: positions/types.ts:176

A note about the stored positions: a code with its parameters, never a sentence for a reader. message is graph-io's English for its own logs.

Properties

code

readonly code: PositionNoteCode

Defined in: positions/types.ts:178

The condition.

---

elements

readonly elements: { count: number; } | readonly number[]

Defined in: positions/types.ts:187

The node indexes it covers, or only their count when it is about the file as a whole.

Union Members

Type Literal

{ count: number; }

count

readonly count: number

How many it covers.

---

readonly number[]

---

message

readonly message: string

Defined in: positions/types.ts:194

graph-io's English; never shown to a reader by graphty-element.

---

params

readonly params: object

Defined in: positions/types.ts:180

How many elements (or columns) it covers, and up to 8 examples.

count

readonly count: number

How many elements (or columns) it covers.

samples

readonly samples: readonly string[]

Up to 8 of their ids (or column names).