API Reference

IExpressionChangeCommitHandler

Internal commit handler contract used by the change transaction manager to flush pending expression changes in a batch.

Description

Defines how one expression node participates in a commit cycle. The change transaction manager gathers handlers and invokes them during flush.

Parameters

ownerAbstractExpression

Expression instance that owns this commit handler.

rootAbstractExpression

Root expression being committed in the current cycle.

pendingCommitsSet<IExpressionChangeCommitHandler>

Remaining handlers queued for the same commit cycle.

Return type

commit(...) returns boolean indicating whether this handler produced a commit.

API

export interface IExpressionChangeCommitHandler {
  owner: AbstractExpression;
  commit: (
    root: AbstractExpression,
    pendingCommits: Set<IExpressionChangeCommitHandler>,
  ) => boolean;
}

Usage example

import type {
  IExpressionChangeCommitHandler,
  AbstractExpression,
} from '@rs-x/expression-parser';

const handler: IExpressionChangeCommitHandler = {
  owner: rootExpression,
  commit(root, pendingCommits) {
    // perform node-specific commit work
    // return true when this handler committed a change
    return true;
  },
};