@socotra/ec-react-utils 2.18.2-next.0 → 2.19.0-next.1

package/dist/index.d.ts

@@ -207,6 +207,22 @@ declare interface ExtractElementDataModelFromTypeInterface {
     }): string | null;
 }
 
+/**
+ * The function `extractElementByType` takes a `QuoteResponse`, `SegmentResponse`, or `ElementResponse` object and an element type string,
+ * and searches for elements matching the specified type from the response or its nested elements.
+ * If a single element is found, it returns that element.
+ * If multiple elements are found, it returns an array of these elements.
+ * If no elements are found, it returns null.
+ *
+ * @param {QuoteResponse | SegmentResponse | ElementResponse} response - The response object (QuoteResponse, SegmentResponse, or ElementResponse)
+ * to search within for the specified element type.
+ * @param {string} elementType - The `elementType` parameter is a string that represents the
+ * type of the element you want to extract from the `response` object.
+ * @returns {T | T[] | null} The function returns a single element of type T if one is found,
+ * an array of T elements (T[]) if multiple are found, or null if no such elements exist.
+ */
+export declare const extractElementsByType: <T extends ElementResponse>(response: QuoteResponse | SegmentResponse | ElementResponse, elementType: string) => T[] | null;
+
 export declare const extractElementsFromQuote: (elements: Array<ElementResponse>, elementType: string) => ({
     locator: string;
     type: string;