Skip to main content

StringExprConfig

Defined in: expr/src/utils/stringExprProcessor.ts:40

Configuration for a string-output ("infix") expression rule processor. Describes how to render each supported operator category around already-serialized lhs/rhs fragments, plus the InfixDialect used to serialize the expression trees themselves.

Properties

compare

compare: Record<string, string>

Defined in: expr/src/utils/stringExprProcessor.ts:48

Maps a canonical scalar operator (=, !=, …) to this format's operator token.


dialect

dialect: InfixDialect

Defined in: expr/src/utils/stringExprProcessor.ts:44

Field/leaf renderers for the expression walker.


fallback

fallback: RuleProcessor

Defined in: expr/src/utils/stringExprProcessor.ts:46

Stock rule processor to fall back to (no expressions, or unsupported operator).


renderBetween

renderBetween: (lhs: string, from: string, to: string, negate: boolean) => string

Defined in: expr/src/utils/stringExprProcessor.ts:54

Renders a between (or negated notBetween) range check.

Parameters

ParameterType
lhsstring
fromstring
tostring
negateboolean

Returns

string


renderNull

renderNull: (lhs: string, notNull: boolean) => string

Defined in: expr/src/utils/stringExprProcessor.ts:52

Renders a null / not-null check.

Parameters

ParameterType
lhsstring
notNullboolean

Returns

string


renderScalar?

optional renderScalar?: (lhs: string, op: string, rhs: string) => string

Defined in: expr/src/utils/stringExprProcessor.ts:50

Renders lhs <op> rhs. Defaults to `${lhs} ${op} ${rhs}`.

Parameters

ParameterType
lhsstring
opstring
rhsstring

Returns

string


renderStringMatch

renderStringMatch: (kind: StringMatchKind, negate: boolean, lhs: string, rhs: string) => string

Defined in: expr/src/utils/stringExprProcessor.ts:59

Renders a string-match op (contains/beginsWith/endsWith and their negations) around serialized lhs/rhs fragments.

Parameters

ParameterType
kindStringMatchKind
negateboolean
lhsstring
rhsstring

Returns

string


serializers

serializers: SQLSerializerRegistry

Defined in: expr/src/utils/stringExprProcessor.ts:42

Built-in serializers for this format (merged under caller overrides).


caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.