@graphty/graphty-element / index / FindResult

Interface: FindResult

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

What GraphSession.find answers: a page of hits, in the RecordPage shape, and value rows.

Properties

notSearchable?

readonly optional notSearchable?: "expression" | "regex"

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

Set when the text is a pattern to run on commit, not text to find: a regex: or = query. Find does not run it and lists nothing; selection.apply({ text }) runs it.

---

offset

readonly offset: number

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

Where the window starts.

---

records

readonly records: readonly FindHit[]

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

The hits in this window, best first.

---

revision

readonly revision: string

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

The input revision the answer was read at; a different one means it is stale.

---

total

readonly total: number

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

How many hits there are in all.

---

values

readonly values: readonly FindValueRow[]

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

At most three matched attribute values, commonest first.