Skip to main content

Interface: NodeSearchOptions

Defined in: src/types/interfaces/graph.interface.ts:98

Node search options.

Properties​

cursor?​

readonly optional cursor: string

Defined in: src/types/interfaces/graph.interface.ts:103


externalIdIdentifier?​

readonly optional externalIdIdentifier: string

Defined in: src/types/interfaces/graph.interface.ts:113


externalIdSystem?​

readonly optional externalIdSystem: string

Defined in: src/types/interfaces/graph.interface.ts:112

Filter nodes whose externalIds array includes an entry matching both externalIdSystem and externalIdIdentifier. Must be used together.

Remarks​

Example: { externalIdSystem: 'cosmik', externalIdIdentifier: 'REFERENCES' } returns nodes whose externalIds includes { system: 'cosmik', identifier: 'REFERENCES' }.


kind?​

readonly optional kind: NodeKind

Defined in: src/types/interfaces/graph.interface.ts:99


limit?​

readonly optional limit: number

Defined in: src/types/interfaces/graph.interface.ts:102


status?​

readonly optional status: NodeStatus

Defined in: src/types/interfaces/graph.interface.ts:101


subkind?​

readonly optional subkind: string

Defined in: src/types/interfaces/graph.interface.ts:100