explainFilter
Generate an explanation if a specific result passes the filter's criteria
Parameters
| Parameter | Type | Default | Notes |
|---|---|---|---|
| filter Required | IFilter | ||
| result Required | GenericResult | ||
| requestOptions Required | IRequestOptions |
Available requestOptions
| Property | Type | Notes |
|---|
Returns
| Property | Type | Notes |
|---|---|---|
| IFilter |
Copy of the Filter |
|
| boolean |
Did the filter match the query? |
|
| IPredicateExplanation[] |
Array of explanations for each predicate in the Filter |
Function defined in common/src/search/_internal/explainFilter.ts:15