Skip to content

Added generic type to getObject method #1546

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Added generic type to getObject method #1546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/client-search/src/searchClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1625,10 +1625,10 @@ export function createSearchClient({
* @param getObject.attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
*/
getObject(
getObject<T = Record<string, any>>(
{ indexName, objectID, attributesToRetrieve }: GetObjectProps,
requestOptions?: RequestOptions,
): Promise<Record<string, unknown>> {
): Promise<T> {
if (!indexName) {
throw new Error('Parameter `indexName` is required when calling `getObject`.');
}
Expand Down