parseJSONata()
Call Signature
parseJSONata(
jsonataInput:string):DefaultRuleGroupType
Defined in: packages/react-querybuilder/src/utils/parseJSONata/parseJSONata.ts:45
Converts a JSONata string expression into a query suitable for the
QueryBuilder component's query or defaultQuery props
(DefaultRuleGroupType).
Parameters
| Parameter | Type |
|---|---|
jsonataInput | string |
Returns
Call Signature
parseJSONata(
jsonataInput:string,options: {fields:OptionList<{[key: string]:unknown;className: Classname | undefined;comparator:string| (f: {[key: string]:unknown;className: Classname | undefined;comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; },operator:string) =>boolean;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }> |Record<string, {[key: string]:unknown;className: Classname | undefined;comparator:string| (f: {[key: string]:unknown;className: Classname | undefined;comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; },operator:string) =>boolean;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }>;generateIDs:boolean;getValueSources: (field:string,operator:string) =>ValueSources;listsAsArrays:boolean; } & {independentCombinators:false; }):DefaultRuleGroupType
Defined in: packages/react-querybuilder/src/utils/parseJSONata/parseJSONata.ts:51
Converts a JSONata string expression into a query suitable for the
QueryBuilder component's query or defaultQuery props
(DefaultRuleGroupType).
Parameters
| Parameter | Type |
|---|---|
jsonataInput | string |
options | { fields: OptionList<{ [key: string]: unknown; className: Classname | undefined; comparator: string | (f: { [key: string]: unknown; className: Classname | undefined; comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }> | Record<string, { [key: string]: unknown; className: Classname | undefined; comparator: string | (f: { [key: string]: unknown; className: Classname | undefined; comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }>; generateIDs: boolean; getValueSources: (field: string, operator: string) => ValueSources; listsAsArrays: boolean; } & { independentCombinators: false; } |
Returns
Call Signature
parseJSONata(
jsonataInput:string,options: {fields:OptionList<{[key: string]:unknown;className: Classname | undefined;comparator:string| (f: {[key: string]:unknown;className: Classname | undefined;comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; },operator:string) =>boolean;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }> |Record<string, {[key: string]:unknown;className: Classname | undefined;comparator:string| (f: {[key: string]:unknown;className: Classname | undefined;comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; },operator:string) =>boolean;defaultOperator:string;defaultValue:any;disabled:boolean;id:string;inputType: InputType | null | undefined;label:string;name:string;operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;placeholder:string;validator:RuleValidator;value:string;valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined;values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined;valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }>;generateIDs:boolean;getValueSources: (field:string,operator:string) =>ValueSources;listsAsArrays:boolean; } & {independentCombinators:true; }):DefaultRuleGroupTypeIC
Defined in: packages/react-querybuilder/src/utils/parseJSONata/parseJSONata.ts:62
Converts a JSONata string expression into a query suitable for the
QueryBuilder component's query or defaultQuery props
(DefaultRuleGroupTypeIC).
Parameters
| Parameter | Type |
|---|---|
jsonataInput | string |
options | { fields: OptionList<{ [key: string]: unknown; className: Classname | undefined; comparator: string | (f: { [key: string]: unknown; className: Classname | undefined; comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }> | Record<string, { [key: string]: unknown; className: Classname | undefined; comparator: string | (f: { [key: string]: unknown; className: Classname | undefined; comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }>; generateIDs: boolean; getValueSources: (field: string, operator: string) => ValueSources; listsAsArrays: boolean; } & { independentCombinators: true; } |
Returns
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.