Skip to main content

getJSPropertyAccessor()

getJSPropertyAccessor(fieldName: string, obj?: string): string

Defined in: packages/core/src/utils/formatQuery/utils.ts:351

Renders a (possibly .-delimited) field name as a JS property accessor on obj (default "this") for MongoDB $where expressions. Segments that aren't plain identifiers use bracket notation with a JSON-escaped string (e.g. a.b c → this.a["b c"]).

Parameters​

ParameterTypeDefault value
fieldNamestringundefined
obj?string'this'

Returns​

string


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.