chore(ts): add MaybePromise wrapper to make APIs shorter to read (#333)

* chore(ts): add MaybePromise wrapper to make APIs shorter to read * Update packages/autocomplete-js/src/types/index.ts
algolia · Oct 12, 2020 · b130b8e · b130b8e
1 parent 001243f
commit b130b8e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 7 deletions.
diff --git a/packages/autocomplete-core/src/types/api.ts b/packages/autocomplete-core/src/types/api.ts
@@ -1,6 +1,7 @@
 import { AutocompleteAccessibilityGetters } from './getters';
 import { AutocompleteSetters } from './setters';
 import { AutocompleteState } from './state';
+import { MaybePromise } from './wrappers';
 
 export interface AutocompleteApi<
   TItem,
@@ -92,7 +93,7 @@ export interface AutocompleteSource<TItem> {
   /**
    * Function called when the input changes. You can use this function to filter/search the items based on the query.
    */
-  getSuggestions(params: GetSourcesParams<TItem>): TItem[] | Promise<TItem[]>;
+  getSuggestions(params: GetSourcesParams<TItem>): MaybePromise<TItem[]>;
   /**
    * Function called when an item is selected.
    */
@@ -163,9 +164,7 @@ export type AutocompletePlugin<TItem, TData> = {
    */
   getSources?(
     params: GetSourcesParams<TItem>
-  ):
-    | Array<AutocompleteSource<TItem>>
-    | Promise<Array<AutocompleteSource<TItem>>>;
+  ): MaybePromise<Array<AutocompleteSource<TItem>>>;
   /**
    * The function called when the autocomplete form is submitted.
    */
@@ -244,9 +243,7 @@ export interface AutocompleteOptions<TItem> {
    */
   getSources(
     params: GetSourcesParams<TItem>
-  ):
-    | Array<AutocompleteSource<TItem>>
-    | Promise<Array<AutocompleteSource<TItem>>>;
+  ): MaybePromise<Array<AutocompleteSource<TItem>>>;
   /**
    * The environment from where your JavaScript is running.
    * Useful if you're using autocomplete in a different context than

diff --git a/packages/autocomplete-core/src/types/wrappers.ts b/packages/autocomplete-core/src/types/wrappers.ts
@@ -0,0 +1 @@
+export type MaybePromise<TResolution> = Promise<TResolution> | TResolution;
diff --git a/packages/autocomplete-js/src/types/index.ts b/packages/autocomplete-js/src/types/index.ts
@@ -52,6 +52,7 @@ export type InternalAutocompleteSource<TItem> = InternalAutocompleteCoreSource<
 type GetSources<TItem> = (
   params: GetSourcesParams<TItem>
 ) =>
+  // TODO: reuse MaybePromise from autocomplete-core when we find a way to share the type
   | Array<AutocompleteCoreSource<TItem>>
   | Promise<Array<AutocompleteCoreSource<TItem>>>;