IWaldiezAgentStore

@waldiez/react v0.5.3

Defined in: src/waldiez/models/Stores/IAgentStore.ts:14

Properties¶

addAgent()¶

addAgent: (agentType, position, parentId) => WaldiezNodeAgent

Defined in: src/waldiez/models/Stores/IAgentStore.ts:35

Add a new agent to the store.

Parameters¶

agentType¶

WaldiezAgentType

position¶

x¶

number

y¶

number

parentId¶

undefined | string

Returns¶

WaldiezNodeAgent

The newly added agent.

See¶

WaldiezNodeAgent

addGroupMember()¶

addGroupMember: (groupId, agentId, position?) => void

Defined in: src/waldiez/models/Stores/IAgentStore.ts:109

Add a member to a specific group.

Parameters¶

groupId¶

string

agentId¶

string

position?¶

XYPosition

Returns¶

void

cloneAgent()¶

cloneAgent: (id) => null | WaldiezNodeAgent

Defined in: src/waldiez/models/Stores/IAgentStore.ts:46

Clone an existing agent.

Parameters¶

id¶

string

Returns¶

null | WaldiezNodeAgent

The cloned agent, or null if the agent was not found.

See¶

WaldiezNodeAgent

deleteAgent()¶

deleteAgent: (id) => void

Defined in: src/waldiez/models/Stores/IAgentStore.ts:58

Delete a specific agent from the store.

Parameters¶

id¶

string

Returns¶

void

exportAgent()¶

exportAgent: (agentId, hideSecrets) => object

Defined in: src/waldiez/models/Stores/IAgentStore.ts:82

Export a specific agent from the store.

Parameters¶

agentId¶

string

hideSecrets¶

boolean

Returns¶

object

The exported agent data.

getAgentById()¶

getAgentById: (id) => null | WaldiezNodeAgent

Defined in: src/waldiez/models/Stores/IAgentStore.ts:27

Get a specific agent by its ID.

Parameters¶

id¶

string

Returns¶

null | WaldiezNodeAgent

The agent with the specified ID, or null if not found.

See¶

WaldiezNodeAgent

getAgentConnections()¶

getAgentConnections: (nodeId, options?) => WaldiezAgentConnections

Defined in: src/waldiez/models/Stores/IAgentStore.ts:89

Get the connections of a specific agent.

Parameters¶

nodeId¶

string

options?¶

sourcesOnly?¶

boolean

targetsOnly?¶

boolean

Returns¶

WaldiezAgentConnections

An object containing sources and targets with their respective nodes and edges.

getAgents()¶

getAgents: () => WaldiezNodeAgent[]

Defined in: src/waldiez/models/Stores/IAgentStore.ts:20

Get the stored agents.

Returns¶

WaldiezNodeAgent[]

An array of agents.

See¶

WaldiezNodeAgent

getGroupMembers()¶

getGroupMembers: (groupId) => WaldiezNodeAgent[]

Defined in: src/waldiez/models/Stores/IAgentStore.ts:102

Get the members of a specific group.

Parameters¶

groupId¶

string

Returns¶

WaldiezNodeAgent[]

An array of agents in the group.

See¶

WaldiezNodeAgent

importAgent()¶

importAgent: (agent, agentId, skipLinks, position, save) => WaldiezNodeAgent

Defined in: src/waldiez/models/Stores/IAgentStore.ts:69

Import an agent into the store.

Parameters¶

agent¶

agentId¶

string

skipLinks¶

boolean

position¶

undefined | { x: number; y: number; }

save¶

boolean

Returns¶

WaldiezNodeAgent

The imported agent.

See¶

WaldiezNodeAgent

removeGroupMember()¶

removeGroupMember: (groupId, memberId) => void

Defined in: src/waldiez/models/Stores/IAgentStore.ts:115

Remove a member from a specific group.

Parameters¶

groupId¶

string

memberId¶

string

Returns¶

void

setAgentGroup()¶

setAgentGroup: (agentId, groupId, position?) => void

Defined in: src/waldiez/models/Stores/IAgentStore.ts:122

Set the group of a specific agent.

Parameters¶

agentId¶

string

groupId¶

string

position?¶

XYPosition

Returns¶

void

updateAgentData()¶

updateAgentData: (id, data) => void

Defined in: src/waldiez/models/Stores/IAgentStore.ts:53

Update the data of a specific agent.

Parameters¶

id¶

string

data¶

Partial\<WaldiezNodeAgentData>

Returns¶

void

See¶

WaldiezNodeAgentData