Type Alias IPublicAction

IPublicAction: { [key in keyof IAction]?: IAction[key] } & {
init(): void | Promise<void>;
}

Public action interface for custom action handler implementations.

Extends IAction with an initialization lifecycle method. Action handlers implement this interface to receive strategy events and perform custom logic.

Lifecycle:

Constructor called with (strategyName, frameName, actionName)
init() called once for async initialization (setup connections, load resources)
Event methods called as strategy executes (signal, breakeven, partialProfit, etc.)
dispose() called once for cleanup (close connections, flush buffers)

Key features:

init() for async initialization (database connections, API clients, file handles)
All IAction methods available for event handling
dispose() guaranteed to run exactly once via singleshot pattern

Common use cases:

State management: Redux/Zustand store integration
Notifications: Telegram/Discord/Email alerts
Logging: Custom event tracking and monitoring
Analytics: Metrics collection and reporting
External systems: Database writes, API calls, file operations

Example

class TelegramNotifier implements Partial<IPublicAction> {
  private bot: TelegramBot | null = null;

  constructor(
    private strategyName: string,
    private frameName: string,
    private actionName: string
  ) {}

  // Called once during initialization
  async init() {
    this.bot = new TelegramBot(process.env.TELEGRAM_TOKEN);
    await this.bot.connect();
  }

  // Called on every signal event
  async signal(event: IStrategyTickResult) {
    if (event.action === 'opened') {
      await this.bot.send(
        `[${this.strategyName}/${this.frameName}] Signal opened: ${event.signal.side}`
      );
    }
  }

  // Called once during cleanup
  async dispose() {
    await this.bot?.disconnect();
    this.bot = null;
  }
}

See

IAction for all available event methods
TActionCtor for constructor signature requirements
ClientAction for internal wrapper that manages lifecycle

Type Alias IPublicAction

Example

See

Settings