Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/agent / progress / ProgressIO

Interface: ProgressIO

Defined in: packages/agent/src/progress/index.ts:78

Public surface returned by createProgressIO. Used by the agent runtime to back agent.progress.write / read.

Stable

Methods

read()

ts
read(currentRunId, options?): Promise<readonly ProgressArtifactRef[]>;

Defined in: packages/agent/src/progress/index.ts:84

Parameters

ParameterType
currentRunIdstring
options?ProgressReadOptions

Returns

Promise&lt;readonly ProgressArtifactRef[]&gt;


rootFor()

ts
rootFor(runId): string;

Defined in: packages/agent/src/progress/index.ts:88

Parameters

ParameterType
runIdstring

Returns

string


write()

ts
write(
   runId, 
   content, 
options?): Promise<ProgressArtifactRef>;

Defined in: packages/agent/src/progress/index.ts:79

Parameters

ParameterType
runIdstring
contentstring
options?ProgressWriteOptions

Returns

Promise&lt;ProgressArtifactRef&gt;