correct usage of SearchResult and SearchMatches needs clarification

[dj-sf]

I am trying to build a plugin that performs a search on the user's vault and returns search results. I want to use native obsidian components for this as much as possible, and I see that there are typescript componts that seem to be designed for this. However after spending many hours in the docs it is not clear to me how to use the Search related typescript API classes and interfaces properly.

The documentation should be improved to clarify the capabilities and usage of Search related components and functions. Without this, the only practical option is to recreate the functionality from scratch in Svelte or React or plain javascript.

Related docs pages: https://docs.obsidian.md/Reference/TypeScript+API/SearchResult https://docs.obsidian.md/Reference/TypeScript+API/SearchMatches https://docs.obsidian.md/Reference/TypeScript+API/renderResults