@sapui5/sap.fe.macros 1.141.1 → 1.142.0

package/src/sap/fe/macros/CollectionBindingInfo.ts

@@ -35,7 +35,13 @@ export type FilterInfo = {
 	caseSensitive?: boolean;
 };
 
-export type CollectionBindingInfo = {
+/**
+ * Type definition for the CollectionBindingInfo used in the Table and Chart controls.
+ * This type is based on the sap.ui.model.odata.v4.ODataListBinding and adds additional parameters used in SAP Fiori elements.
+ * @public
+ * @typedef
+ */
+export type SerializedCollectionBindingInfo = {
 	events?: Record<string, Function>;
 	suspended?: boolean;
 	path?: string;
@@ -76,13 +82,12 @@ export type EventHandler = {
  * @alias sap.fe.macros.CollectionBindingInfo
  * @public
  */
-
 export default class CollectionBindingInfoAPI {
-	private collectionBindingInfo: CollectionBindingInfo;
+	private collectionBindingInfo: SerializedCollectionBindingInfo;
 
 	private attachedEvents: EventHandler[] = [];
 
-	constructor(bindingInfo: CollectionBindingInfo) {
+	constructor(bindingInfo: SerializedCollectionBindingInfo) {
 		this.collectionBindingInfo = bindingInfo;
 	}
 
@@ -173,12 +178,12 @@ export default class CollectionBindingInfoAPI {
 	}
 
 	/**
-	 * Retrieve the 'serialized' binding info, useful if you want to create your own binding
+	 * Retrieve the 'serialized' binding info which is useful if you want to create your own binding
 	 * @returns {CollectionBindingInfo} The {@link sap.fe.macros.CollectionBindingInfo "CollectionBindingInfo"}
 	 * @public
 	 */
 
-	getBindingInfo(): CollectionBindingInfo {
+	getBindingInfo(): SerializedCollectionBindingInfo {
 		const clonedBindingInfo = { ...this.collectionBindingInfo };
 
 		// Making deepClones of objects (except Sorters because we can't)