@limetech/lime-elements 36.2.0-next.1 → 36.2.0-next.3

package/dist/types/components/picker/picker.d.ts

@@ -51,6 +51,9 @@ export declare class Picker {
    * A search function that takes a search-string as an argument,
    * and returns a promise that will eventually be resolved with
    * an array of `ListItem`:s.
+   *
+   * See the docs for the type `Searcher` for type information on
+   * the searcher function itself.
    */
   searcher: Searcher;
   /**

package/dist/types/components/picker/searcher.types.d.ts

@@ -1,2 +1,10 @@
 import { ListItem } from '../list/list-item.types';
+/**
+ * A search function that takes a search-string as an argument, and returns
+ * a promise that will eventually be resolved with an array of `ListItem`:s.
+ *
+ * @param {string} query A search query. Typically what the user has written
+ * in the input field of a limel-picker.
+ * @returns {Promise<ListItem[]>} The search result.
+ */
 export declare type Searcher = (query: string) => Promise<ListItem[]>;

package/dist/types/components.d.ts

@@ -853,7 +853,7 @@ export namespace Components {
          */
         "searchLabel": string;
         /**
-          * A search function that takes a search-string as an argument, and returns a promise that will eventually be resolved with an array of `ListItem`:s.
+          * A search function that takes a search-string as an argument, and returns a promise that will eventually be resolved with an array of `ListItem`:s.  See the docs for the type `Searcher` for type information on the searcher function itself.
          */
         "searcher": Searcher;
         /**
@@ -2659,7 +2659,7 @@ declare namespace LocalJSX {
          */
         "searchLabel"?: string;
         /**
-          * A search function that takes a search-string as an argument, and returns a promise that will eventually be resolved with an array of `ListItem`:s.
+          * A search function that takes a search-string as an argument, and returns a promise that will eventually be resolved with an array of `ListItem`:s.  See the docs for the type `Searcher` for type information on the searcher function itself.
          */
         "searcher"?: Searcher;
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "36.2.0-next.1",
+  "version": "36.2.0-next.3",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",