import { warn } from './warn';

import type { ISettingsMap } from './warn';

/**

* Warns when a deprecated props are being used.

*

* @public

* @param componentName - The name of the component being used.

* @param props - The props passed into the component.

* @param deprecationMap - The map of deprecations, where key is the prop name and the value is

* either null or a replacement prop name.

*/

export function warnDeprecations<P extends {}>(componentName: string, props: P, deprecationMap: ISettingsMap<P>): void {

if (process.env.NODE_ENV !== 'production') {

for (const propName in deprecationMap) {

if (props && propName in props) {

let deprecationMessage = `${componentName} property '${propName}' was used but has been deprecated.`;

const replacementPropName = deprecationMap[propName];

if (replacementPropName) {

deprecationMessage += ` Use '${replacementPropName}' instead.`;

}

warn(deprecationMessage);

}

}

}

}