# BetaExpressionModule (/docs/core/reference/api/interfaces/BetaExpressionModule)



[@kysoql/core](/docs/core/reference/api) / BetaExpressionModule

Beta expression helpers for Salesforce formula-field filter functions.

## Type Parameters [#type-parameters]

| Type Parameter            |
| ------------------------- |
| `DB`                      |
| `TB` *extends* keyof `DB` |

## Methods [#methods]

<a id="api-formula" />

### formula() [#formula]

```ts
formula<Left, Operator, Right>(
   left,
   operator,
   right
): FormulaFilterFunctionExpression<FormulaResultValue<DB, TB, Left, Operator, Right>>;
```

Builds a beta formula expression for a filter predicate.

#### Type Parameters [#type-parameters-1]

| Type Parameter                                                                                                      |
| ------------------------------------------------------------------------------------------------------------------- |
| `Left` *extends* `string`                                                                                           |
| `Operator` *extends* [`FormulaArithmeticOperator`](/docs/core/reference/api/type-aliases/FormulaArithmeticOperator) |
| `Right` *extends* `string`                                                                                          |

#### Parameters [#parameters]

| Parameter  | Type                                                                                                                                     |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `left`     | `Left` & [`FilterableFormulaFieldReference`](/docs/core/reference/api/type-aliases/FilterableFormulaFieldReference)\<`DB`, `TB`, `Left`> |
| `operator` | `Operator`                                                                                                                               |
| `right`    | `Right` & `FormulaRightFieldReference`\<`DB`, `TB`, `Left`, `Operator`, `Right`>                                                         |

#### Returns [#returns]

[`FormulaFilterFunctionExpression`](/docs/core/reference/api/interfaces/FormulaFilterFunctionExpression)\<`FormulaResultValue`\<`DB`, `TB`, `Left`, `Operator`, `Right`>>