blakmatrix / node-zendesk

A trusted Zendesk API client library for Node.js and the browser, lovingly maintained for over 10 years.

Home Page:https://blakmatrix.github.io/node-zendesk/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

nicolaerusan opened this issue · comments

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.