Packages  ›  trotsky  ›  StepWhen

StepWhen class

Represents a conditional step that evaluates a predicate to determine its outcome.

Signature:

export declare class StepWhen<P = StepBuilder, C = unknown, O = boolean> extends Step<P, C, O>

Extends: Step<P, C, O>

Remarks

This step evaluates a predicate, which can be a boolean value or a resolvable that resolves to a boolean. The result of the predicate evaluation is stored in the output.

Example 1

Filter posts by like count:

await Trotsky.init(agent)
  .searchPosts({ q: "typescript" })
  .take(20)
  .each()
  .when((step) => step?.context?.likeCount > 10)
  .like()
  .run()

Example 2

Conditional following:

await Trotsky.init(agent)
  .actor("myhandle.bsky.social")
  .followers()
  .each()
  .when((step) => !step?.context?.viewer?.following)
  .follow()
  .wait(2000)
  .run()

Constructors

Constructor	Modifiers	Description
(constructor)(agent, parent, predicate)		Creates an instance of StepWhen.

Methods

Method	Modifiers	Description
apply()		Evaluates the predicate and sets the output to its result.
clone(rest)		Clones the current step and returns a new instance with the same parameters.