Skip to content

ChainGraph API Documentation / @badaitech/chaingraph-types / RuleBuilder

Class: RuleBuilder

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:447

Builder for creating transfer rules with fluent API

Constructors

Constructor

new RuleBuilder(name): RuleBuilder

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:450

Parameters

name

string

Returns

RuleBuilder

Methods

behaviors()

behaviors(behaviors): this

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:473

Set behaviors for the rule

Parameters

behaviors

TransferBehaviors

Returns

this


build()

build(): TransferRule

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:497

Build the rule

Returns

TransferRule


from()

from(predicate): this

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:457

Set source predicate

Parameters

predicate

PortPredicate

Returns

this


to()

to(predicate): this

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:465

Set target predicate

Parameters

predicate

PortPredicate

Returns

this


withDescription()

withDescription(description): this

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:489

Set description

Parameters

description

string

Returns

this


withPriority()

withPriority(priority): this

Defined in: packages/chaingraph-types/src/port/transfer-rules/engine.ts:481

Set priority

Parameters

priority

number

Returns

this

Licensed under BUSL-1.1