Skip to content

Documentation / @agentick/core / runComponent

Function: runComponent() ​

runComponent<P>(Component, input, options?): Promise<SessionExecutionHandle>

Defined in: core/src/app.ts:93

Execute a component with input (ephemeral session).

Returns SessionExecutionHandle (AsyncIterable, not PromiseLike):

  • await handle.result → SendResult
  • for await (const event of handle) → StreamEvent

Type Parameters ​

P ​

P

Parameters ​

Component ​

ComponentFunction<P>

input ​

RunInput<P>

options? ​

AppOptions = {}

Returns ​

Promise<SessionExecutionHandle>

Examples ​

typescript
const handle = await runComponent(MyAgent, {
  props: { systemPrompt: "Be helpful" },
  messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
}, { model });
const result = await handle.result;
typescript
const handle = await runComponent(MyAgent, {
  props: { systemPrompt: "Be helpful" },
  messages: [{ role: "user", content: [{ type: "text", text: "Hello!" }] }],
}, { model });
for await (const event of handle) {
  console.log(event);
}

Released under the ISC License.