ChainGraph API Documentation / @badaitech/chaingraph-types / NodeCatalog

Class: NodeCatalog

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:13

Constructors

Constructor

new NodeCatalog(): NodeCatalog

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:27

Returns

NodeCatalog

Methods

clear()

clear(): void

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:212

Clear all cached node and category registrations.

Returns

void

---

getAllNodes()

getAllNodes(): CategorizedNodes[]

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:140

Get all available nodes grouped by categories. Categories are sorted based on the metadata order.

Returns

CategorizedNodes[]

---

getCategories()

getCategories(): string[]

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:167

Get all available categories that have nodes registered.

Returns

string[]

---

getNodeByType()

getNodeByType(type): INode | undefined

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:160

Get a registered node instance by its type.

Parameters

type

string

Returns

INode | undefined

---

getNodesByCategory()

getNodesByCategory(category): CategorizedNodes | undefined

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:151

Get nodes for a specific category.

Parameters

category

string

Returns

CategorizedNodes | undefined

---

registerCategory()

registerCategory(category, metadata): void

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:62

Register a new category with its metadata. If the category already exists, its metadata will be overwritten.

Parameters

category

string

metadata

CategoryMetadata

Returns

void

---

registerNode()

registerNode(type, node, categoryOverride?): void

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:90

Register a node instance in the catalog within a specific category. The category can be provided as the second parameter. If not provided, the node's own metadata.category is used. If still not defined, the node will be registered under a default category identifier ("other").

Parameters

type

string

A unique identifier for the node

node

INode

categoryOverride?

string

Optional category id to force registration into a specific category.

Returns

void

---

searchNodes()

searchNodes(query): CategorizedNodes[]

Defined in: packages/chaingraph-types/src/node/node-catalog.ts:177

Search nodes by a query across all categories. Searches in node title, description and tags.

Parameters

query

string

Returns

CategorizedNodes[]