Skip to content

Missing documentation: Fuse.jsΒ #89

@damms005

Description

@damms005

In README.md under How to define search synonyms, I believe it should be explicitly made clear the effect of the filteredItems() function using Fuse JS, to the end that the result returned from the Spotlight command on the backend may not be shown/displayed on the frontend because it is filtered out from what is displayed to the user, differently from what is returned by the backend.

I lost quality time trying to debug why I returned items as SpotlightSearchResult but nothing showed up on the frontend. I had to dive into the code to figure that out, and I believe such crucial behaviour should be documented.

Please let me know if a PR that updates the doc to this effect is welcomed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions