Skip to content

@graphty/graphty-element / session / ItemKey

Type Alias: ItemKey ​

ItemKey = object

Defined in: graphty-element/src/catalog/types.ts:1206

How an item is found in a result. A field matches when it equals the value or, for an array-valued field, contains it.

OPEN UNION: forms may be added in a minor release; handle unknown forms.

Properties ​

field ​

readonly field: string

Defined in: graphty-element/src/catalog/types.ts:1208

The result field, such as group for a community or onPath for a path.


value ​

readonly value: string | number | boolean

Defined in: graphty-element/src/catalog/types.ts:1210

The value an element's field equals, or its array contains, to be in the item.