@usine/core/step/result

Classes

Comment

A GitHub comment the agent created or updated during the Attempt.

Extends

• Schema.Class

Constructors

Constructor

new Comment(…args): Comment

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Comment

Properties

url

readonly url: URL

---

Commit

A commit the executor found between the workspace base and final HEAD.

Extends

• Schema.Class

Constructors

Constructor

new Commit(…args): Commit

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

Commit

Properties

sha

readonly sha: string & Brand<"CommitSha">

summary

readonly summary: string

---

PullRequest

A pull request the agent created or updated during the Attempt.

Extends

• Schema.Class

Constructors

Constructor

new PullRequest(…args): PullRequest

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

PullRequest

Properties

number

readonly number: number

url

readonly url: URL

---

StepResult

The agent’s final message plus the facts that survive workspace cleanup.

Extends

• Schema.Class

Constructors

Constructor

new StepResult(…args): StepResult

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

StepResult

Properties

facts

readonly facts: readonly (Commit | PullRequest | Comment)[]

message

readonly message: string

Type Aliases

StepResultFact

StepResultFact = typeof StepResultFact.Type

A commit or GitHub artifact recorded as an outcome of the Agent’s work.

Variables

StepResultFact

const StepResultFact: Schema.Union<readonly [typeof Commit, typeof PullRequest, typeof Comment]>

A commit or GitHub artifact recorded as an outcome of the Agent’s work.