You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,26 +57,26 @@ isQueryValid('SELECT Id Foo FROM Baz'); // false
57
57
58
58
Many of hte utility functions are provided to easily determine the shape of specific data since there are many variations. If you are using Typescript in strict mode, you can use these to narrow types with if statements.
| hasAlias | Returns `true` if the field passed in has the `alias` property. | input: `string | ComposeFieldInput`|
63
-
| getField | Convenience method to construct fields in the correct format when using `composeQuery()`. Look in the data models section below for the structure of `ComposeFieldInput`. | input: `string | ComposeFieldInput`|
64
-
| getFlattenedFields | Flatten a Salesforce record based on the parsed SOQL Query. this is useful if you have relationships in your query and want to show the results in a table, using `.` dot notation for the relationship field headings. | soql: `Query | Subquery| FieldSubquery`<br> config?: `SoqlComposeConfig` |
65
-
| isSubquery | Returns `true` if the data passed in is a subquery. | query: `Query | Subquery`|
66
-
| isFieldSubquery | Returns `true` if the data passed in is a FieldSubquery. | value: `any`|
67
-
| isWhereClauseWithRightCondition | Returns `true` if the value passed in is a `WhereClause` with an `operator` and `right` property | value: `WhereClause`|
68
-
| isHavingClauseWithRightCondition | Returns `true` if the value passed in is a `HavingClause` with an `operator` and `right` property | value: `HavingClause`|
69
-
| isWhereOrHavingClauseWithRightCondition | Returns `true` if the value passed in is a `WhereClause` or `HavingClause` with an `operator` and `right` property | value: `WhereClause | HavingClause` |
70
-
| isValueCondition | Returns `true` if the value passed in has `field`, `operator` and `value` properties | value: `Condition`|
71
-
| isValueWithDateLiteralCondition | Returns `true` if the value passed in has `field`, `operator` and `value` properties and has a `literalType` property that is `DATE_LITERAL` of `['DATE_LITERAL',...]`| value: `Condition`|
72
-
| isValueWithDateNLiteralCondition | Returns `true` if the value passed in has `field`, `operator`, `value` and `dateLiteralVariable` properties | value: `Condition`|
73
-
| isValueFunctionCondition | Returns `true` if the value passed in has `fn`, `operator` and `value` properties | value: `Condition`|
74
-
| isNegationCondition | Returns `true` if the value passed in has a `openParen` property and does not have `fn`, `field`, `operator`, `value`, and `closeParen` properties | value: `Condition`|
75
-
| isValueQueryCondition | Returns `true` if the value passed in has `field`, `operator` and `valueQuery` properties and does not have a `value` property | value: `Condition | ValueQueryCondition`|
76
-
| isOrderByField | Returns `true` if the value passed in has `field` property | value: `OrderByClause`|
77
-
| isOrderByFn | Returns `true` if the value passed in has `fn` property | value: `OrderByClause`|
78
-
| isGroupByField | Returns `true` if the value passed in has `field` property | value: `GroupByClause`|
79
-
| isGroupByFn | Returns `true` if the value passed in has `fn` property | value: `GroupByClause`|
| hasAlias | Returns `true` if the field passed in has the `alias` property. | input: `string | ComposeFieldInput`|
63
+
| getField | Convenience method to construct fields in the correct format when using `composeQuery()`. Look in the data models section below for the structure of `ComposeFieldInput`. | input: `string | ComposeFieldInput`|
64
+
| getFlattenedFields | Flatten a Salesforce record based on the parsed SOQL Query. this is useful if you have relationships in your query and want to show the results in a table, using `.` dot notation for the relationship field headings. | soql: `Query | Subquery | FieldSubquery`<br> config?: `SoqlComposeConfig` |
65
+
| isSubquery | Returns `true` if the data passed in is a subquery. | query: `Query | Subquery`|
66
+
| isFieldSubquery | Returns `true` if the data passed in is a FieldSubquery. | value: `any`|
67
+
| isWhereClauseWithRightCondition | Returns `true` if the value passed in is a `WhereClause` with an `operator` and `right` property | value: `WhereClause`|
68
+
| isHavingClauseWithRightCondition | Returns `true` if the value passed in is a `HavingClause` with an `operator` and `right` property | value: `HavingClause`|
69
+
| isWhereOrHavingClauseWithRightCondition | Returns `true` if the value passed in is a `WhereClause` or `HavingClause` with an `operator` and `right` property | value: `WhereClause | HavingClause`|
70
+
| isValueCondition | Returns `true` if the value passed in has `field`, `operator` and `value` properties | value: `Condition`|
71
+
| isValueWithDateLiteralCondition | Returns `true` if the value passed in has `field`, `operator` and `value` properties and has a `literalType` property that is `DATE_LITERAL` of `['DATE_LITERAL',...]`| value: `Condition`|
72
+
| isValueWithDateNLiteralCondition | Returns `true` if the value passed in has `field`, `operator`, `value` and `dateLiteralVariable` properties | value: `Condition`|
73
+
| isValueFunctionCondition | Returns `true` if the value passed in has `fn`, `operator` and `value` properties | value: `Condition`|
74
+
| isNegationCondition | Returns `true` if the value passed in has a `openParen` property and does not have `fn`, `field`, `operator`, `value`, and `closeParen` properties | value: `Condition`|
75
+
| isValueQueryCondition | Returns `true` if the value passed in has `field`, `operator` and `valueQuery` properties and does not have a `value` property | value: `Condition | ValueQueryCondition`|
76
+
| isOrderByField | Returns `true` if the value passed in has `field` property | value: `OrderByClause`|
77
+
| isOrderByFn | Returns `true` if the value passed in has `fn` property | value: `OrderByClause`|
78
+
| isGroupByField | Returns `true` if the value passed in has `field` property | value: `GroupByClause`|
79
+
| isGroupByFn | Returns `true` if the value passed in has `fn` property | value: `GroupByClause`|
0 commit comments