explainPropPredicate
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
_predicate Required | Record<stringIMatchOptions> | ||
_result Required | GenericResult | ||
_requestOptions Required | IRequestOptions |
Returns
Property | Type | Notes |
---|---|---|
boolean |
Did the predicate match the query? |
|
IPredicate |
Copy of the Predicate |
|
IMatchReason[] |
Array of reasons why the predicate matched the query |
|
Optional | Record<stringany> |
Additional information about the predicate which can be useful when preparing a UI to display the explanation |
Function defined in packages/common/src/search/_internal/explainHelpers.ts:18