Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include type definition or more extensive docs for the response of client.search.query #406

Open
nicolaerusan opened this issue Feb 14, 2024 · 0 comments

Comments

@nicolaerusan
Copy link

Feature Description
Unclear what the response format is of the search functions - it's typed to just return an object:
const searchResults = await client.search.query(encodedQuery);

type:
query(searchTerm: string): Promise<object>;

Example Use Case
Provide an example or context where this feature would be beneficial.

Would be helpful to have a short code sample that shows the usage of searchResults in practice, or additional type information on the response syntax.

Additional Information
Any other details or ideas related to the feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant