Class AutoBeTokenUsageComponent

constructor

• new AutoBeTokenUsageComponent(): AutoBeTokenUsageComponent

  Default Constructor.

  Creates a new token usage component with all counters initialized to zero. Constructs fresh input and output objects with default values, providing a clean starting point for tracking token consumption in an agent phase.

  Returns AutoBeTokenUsageComponent
• new AutoBeTokenUsageComponent(
      props: Omit<IAutoBeTokenUsageJson.IComponent, "total">,
  ): AutoBeTokenUsageComponent

  Initializer Constructor.

  Creates a new component populated with existing token usage data. Directly assigns the provided values to instance properties, preserving the exact token counts and structure from the source data for accurate tracking continuation.

  Parameters

  • props: Omit<IAutoBeTokenUsageJson.IComponent, "total">

    Token usage data to initialize the component

  Returns AutoBeTokenUsageComponent

Readonlyinput

Readonlyoutput

total

• get total(): number

  Total token count combining all input and output tokens.

  Represents the complete token consumption for this component, providing a single metric for overall resource utilization. This value is critical for cost calculations and comparing efficiency across different agents or processing phases.

  Returns number

increment

• increment(props: IAutoBeTokenUsageJson.IComponent): void

  Add token usage data to current statistics.

  Increments all token counters in this component by the corresponding values from the provided component data. This method performs in-place updates, modifying the current instance rather than creating a new one.

  Updates include:

  • Total token count
  • Input tokens (both total and cached)
  • Output tokens (reasoning, accepted/rejected predictions)

  Parameters

  • props: IAutoBeTokenUsageJson.IComponent

    Token usage component data to add to current values

  Returns void

toJSON

• toJSON(): IAutoBeTokenUsageJson.IComponent

  Export token usage data as JSON.

  Converts the component's token usage statistics to the standardized IAutoBeTokenUsageJson.IComponent format. This serialization maintains the complete structure including total counts and detailed breakdowns for both input and output tokens.

  Returns IAutoBeTokenUsageJson.IComponent

  JSON representation of the token usage component

Staticminus

• minus(
      a: AutoBeTokenUsageComponent,
      b: AutoBeTokenUsageComponent,
  ): AutoBeTokenUsageComponent

  Parameters

  • a: AutoBeTokenUsageComponent
  • b: AutoBeTokenUsageComponent

  Returns AutoBeTokenUsageComponent

Staticplus

• plus(
      a: AutoBeTokenUsageComponent,
      b: AutoBeTokenUsageComponent,
  ): AutoBeTokenUsageComponent

  Create new component combining two token usage statistics.

  Performs element-wise addition of all token counters from two components, creating a new AutoBeTokenUsageComponent instance with the combined totals. This static method is useful for aggregating token usage across multiple agent invocations or combining statistics from parallel processing.

  Parameters

  • a: AutoBeTokenUsageComponent

    First token usage component
  • b: AutoBeTokenUsageComponent

    Second token usage component

  Returns AutoBeTokenUsageComponent

  New component with combined token statistics