flip/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/DefinitelyTyped.git synced 2026-02-06 10:56:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[Algolia]: Fix AlgoliaPlaces (param language) (#35589)

Browse Source 
* 🚑 Fix type when there is a param language in query

* 📓 Extend generic type
This commit is contained in:
aDEVE 2019-05-21 21:55:12 +02:00 committed by Ryan Cavanaugh
parent 5251fb7936
commit d625bf3d51
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
types/algoliasearch/index.d.ts vendored
View File

@ -1910,32 +1910,51 @@ declare namespace algoliasearch {
}
namespace Places {
interface LanguageInterface {
/**
* If specified, restrict the search results to a single language. You can pass two letters country codes (ISO 639-1).
* Warning: language parameter is case sensitive and should be lowercase otherwise it will fallback to default language.
* https://community.algolia.com/places/api-clients.html#api-options-language
*/
language: string
}
interface PlaceInterface {
/**
* Endpoint to search.
* https://community.algolia.com/places/api-clients.html#endpoints
*/
search(e: QueryInterface, cb: (err: Error, response: ResultSearchInterface) => void): void;
/**
* If specified, restrict the search results to a single language. You can pass two letters country codes (ISO 639-1).
* Warning: language parameter is case sensitive and should be lowercase otherwise it will fallback to default language.
* https://community.algolia.com/places/api-clients.html#api-options-language
*/
search(e: QueryInterface, cb: (err: Error, response: ResultSearchInterface<HitInterface>) => void): void;
search(e: QueryInterface & LanguageInterface, cb: (err: Error, response: ResultSearchInterface<LocalizedHitInterface>) => void): void;
/**
* Endpoint to search.
* https://community.algolia.com/places/api-clients.html#endpoints
*/
search(e: QueryInterface): Promise<ResultSearchInterface>;
// search(e: LocalizedQueryInterface): Promise<LocalizedResultSearchInterface>;
search(e: QueryInterface): Promise<ResultSearchInterface<HitInterface>>;
search(e: QueryInterface & LanguageInterface): Promise<ResultSearchInterface<LocalizedHitInterface>>;
/**
* Reverse geocoding means converting a location (latitude and longitude) to a readable address.
* https://community.algolia.com/places/api-clients.html#endpoints
*/
reverse(e: QueryReverseInterface, cb: (err: Error, response: ResultSearchInterface) => void): void;
reverse(e: QueryReverseInterface, cb: (err: Error, response: ResultSearchInterface<HitInterface>) => void): void;
reverse(e: QueryReverseInterface & LanguageInterface, cb: (err: Error, response: ResultSearchInterface<LocalizedHitInterface>) => void): void;
/**
* Reverse geocoding means converting a location (latitude and longitude) to a readable address.
* https://community.algolia.com/places/api-clients.html#endpoints
*/
reverse(e: QueryReverseInterface): Promise<ResultSearchInterface>;
reverse(e: QueryReverseInterface): Promise<ResultSearchInterface<HitInterface>>;
reverse(e: QueryReverseInterface & LanguageInterface): Promise<ResultSearchInterface<LocalizedHitInterface>>;
}
/**
@ -1957,12 +1976,6 @@ declare namespace algoliasearch {
* https://community.algolia.com/places/api-clients.html#api-options-type
*/
hitsPerPage?: number;
/**
* If specified, restrict the search results to a single language. You can pass two letters country codes (ISO 639-1).
* Warning: language parameter is case sensitive and should be lowercase otherwise it will fallback to default language.
* https://community.algolia.com/places/api-clients.html#api-options-language
*/
language?: string;
/**
* If specified, restrict the search results to a specific list of comma-separated countries. You can pass two letters country codes (ISO 3166-1).
* Default: Search on the whole planet.
@ -2013,24 +2026,18 @@ declare namespace algoliasearch {
* https://community.algolia.com/places/api-clients.html#api-options-type
*/
hitsPerPage?: number;
/**
* If specified, restrict the search results to a single language. You can pass two letters country codes (ISO 639-1).
* Warning: language parameter is case sensitive and should be lowercase otherwise it will fallback to default language.
* https://community.algolia.com/places/api-clients.html#api-options-language
*/
language?: string;
}
/**
* Result of search.
* https://community.algolia.com/places/api-clients.html#json-answer
*/
interface ResultSearchInterface {
interface ResultSearchInterface<T extends HitInterface | LocalizedHitInterface> {
/**
* Contains all the hits matching the query.
* https://community.algolia.com/places/api-clients.html#json-answer
*/
hits: HitInterface[] | LocalizedHitInterface[];
hits: T[];
/**
* Query fallback if query retrieve any result
* https://community.algolia.com/places/api-clients.html#json-answer