ValueProcessorOptions

Options object for ValueProcessorByRule functions.

Extends

• FormatQueryOptions

Properties

escapeQuotes?

optional escapeQuotes: boolean

Source

packages/react-querybuilder/src/types/importExport.ts:144

---

fallbackExpression?

optional fallbackExpression: string

This string will be inserted in place of invalid groups for non-JSON formats. Defaults to '(1 = 1)' for "sql"/"parameterized"/"parameterized_named" and '$and:[{$expr:true}]' for "mongodb".

Inherited from

FormatQueryOptions . fallbackExpression

Source

packages/react-querybuilder/src/types/importExport.ts:80

---

fieldData?

optional fieldData: FullField<string, string, string, Option<string>, Option<string>>

The full field object, if fields was provided in the formatQuery options parameter.

Source

packages/react-querybuilder/src/types/importExport.ts:149

---

fieldParamNames?

optional fieldParamNames: Record<string, string[]>

Included for the "parameterized_named" format only. Keys of this object represent field names and values represent the current list of parameter names for that field based on the query rules processed up to that point. Use this list to ensure that parameter names generated by the custom rule processor are unique.

Source

packages/react-querybuilder/src/types/importExport.ts:162

---

fields?

optional fields: FlexibleOptionList <FullField<string, string, string, Option<string>, Option<string>>>

This can be the same FullField array passed to QueryBuilder, but really all you need to provide is the name and validator for each field.

The full field object from this array, where the field's identifying property matches the rule's field, will be passed to the rule processor.

Inherited from

FormatQueryOptions . fields

Source

packages/react-querybuilder/src/types/importExport.ts:74

---

format?

optional format: ExportFormat

The ExportFormat.

Inherited from

FormatQueryOptions . format

Source

packages/react-querybuilder/src/types/importExport.ts:31

---

getNextNamedParam()?

optional getNextNamedParam: (field) => string

Included for the "parameterized_named" format only. Call this function with a field name to get a unique parameter name, as yet unused during query processing.

Parameters

Parameter	Type
field	string

Returns

string

Source

packages/react-querybuilder/src/types/importExport.ts:167

---

numberedParams?

optional numberedParams: boolean

Renders parameter placeholders as a series of sequential numbers instead of '?' like the default. This option will respect the paramPrefix option like the 'parameterized_named' format.

Default

false

Inherited from

FormatQueryOptions . numberedParams

Source

packages/react-querybuilder/src/types/importExport.ts:112

---

paramPrefix?

optional paramPrefix: string

This string will be placed in front of named parameters (aka bind variables) when using the "parameterized_named" export format.

Default

":"

Inherited from

FormatQueryOptions . paramPrefix

Source

packages/react-querybuilder/src/types/importExport.ts:87

---

paramsKeepPrefix?

optional paramsKeepPrefix: boolean

Maintains the parameter prefix in the params object keys when using the "parameterized_named" export format. Recommended when using SQLite.

Default

false

Example

console.log(formatQuery(query, {
  format: "parameterized_named",
  paramPrefix: "$",
  paramsKeepPrefix: true
}).params)
// { $firstName: "Stev" }
// Default (`paramsKeepPrefix` is `false`):
// { firstName: "Stev" }

Inherited from

FormatQueryOptions . paramsKeepPrefix

Source

packages/react-querybuilder/src/types/importExport.ts:104

---

parseNumbers?

optional parseNumbers: boolean

Renders values as either number-types or unquoted strings, as appropriate and when possible. Each string-type value is evaluated against numericRegex to determine if it can be represented as a plain numeric value. If so, parseFloat is used to convert it to a number.

Inherited from

FormatQueryOptions . parseNumbers

Source

packages/react-querybuilder/src/types/importExport.ts:119

---

placeholderFieldName?

optional placeholderFieldName: string

Any rules where the field is equal to this value will be ignored.

Default

'~'

Inherited from

FormatQueryOptions . placeholderFieldName

Source

packages/react-querybuilder/src/types/importExport.ts:125

---

placeholderOperatorName?

optional placeholderOperatorName: string

Any rules where the operator is equal to this value will be ignored.

Default

'~'

Inherited from

FormatQueryOptions . placeholderOperatorName

Source

packages/react-querybuilder/src/types/importExport.ts:131

---

quoteFieldNamesWith?

optional quoteFieldNamesWith: string | [string, string]

In the "sql"/"parameterized"/"parameterized_named" export formats, field names will be bracketed by this string. If an array of strings is passed, field names will be preceded by the first element and succeeded by the second element. A common value for this option is the backtick ('`').

Default

'' // the empty string

Examples

formatQuery(query, { format: 'sql', quoteFieldNamesWith: '`' })
// "`First name` = 'Steve'"

formatQuery(query, { format: 'sql', quoteFieldNamesWith: ['[', ']'] })
// "[First name] = 'Steve'"

Inherited from

FormatQueryOptions . quoteFieldNamesWith

Source

packages/react-querybuilder/src/types/importExport.ts:61

---

quoteValuesWith?

optional quoteValuesWith: string

Character to use for quoting string values in the SQL format.

Default

'''

Inherited from

FormatQueryOptions . quoteValuesWith

Source

packages/react-querybuilder/src/types/importExport.ts:136

---

ruleProcessor?

optional ruleProcessor: RuleProcessor

This function will be used to process each rule for query language formats. If not defined, the appropriate defaultRuleProcessor for the format will be used.

Inherited from

FormatQueryOptions . ruleProcessor

Source

packages/react-querybuilder/src/types/importExport.ts:43

---

validator?

optional validator: QueryValidator

Validator function for the entire query. Can be the same function passed as validator prop to QueryBuilder.

Inherited from

FormatQueryOptions . validator

Source

packages/react-querybuilder/src/types/importExport.ts:66

---

valueProcessor?

optional valueProcessor: ValueProcessorByRule

This function will be used to process the value from each rule for query language formats. If not defined, the appropriate defaultValueProcessor for the format will be used.

Overrides

FormatQueryOptions . valueProcessor

Source

packages/react-querybuilder/src/types/importExport.ts:143

---

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.