lowercase-keys 2.0.0 → 4.0.0

package/index.d.ts

@@ -1,3 +1,49 @@
+export type OnConflictArgument<T> = {
+	/**
+	The lowercased key that conflicts.
+	*/
+	key: string;
+
+	/**
+	The new value that is being set.
+	*/
+	newValue: T;
+
+	/**
+	The existing value that was already set.
+	*/
+	existingValue: T;
+};
+
+export type Options<T> = {
+	/**
+	A function that is called when multiple keys in the input object map to the same lowercased key.
+
+	The function receives the lowercased key, the new value, and the existing value, and should return the value to use.
+
+	By default, the last value wins.
+
+	@example
+	```
+	import lowercaseKeys from 'lowercase-keys';
+
+	// Throw on conflict
+	lowercaseKeys({Key: 'value1', key: 'value2'}, {
+		onConflict({key}) {
+			throw new Error(`Duplicate key: ${key}`);
+		}
+	});
+
+	// Keep the first value
+	lowercaseKeys({Key: 'value1', key: 'value2'}, {
+		onConflict: ({existingValue}) => existingValue,
+	});
+	//=> {key: 'value1'}
+	```
+	*/
+	onConflict?: (argument: OnConflictArgument<T>) => T;
+};
+
 /**
 Lowercase the keys of an object.
 
@@ -5,12 +51,10 @@ Lowercase the keys of an object.
 
 @example
 ```
-import lowercaseKeys = require('lowercase-keys');
+import lowercaseKeys from 'lowercase-keys';
 
 lowercaseKeys({FOO: true, bAr: false});
 //=> {foo: true, bar: false}
 ```
 */
-declare function lowercaseKeys<T extends unknown>(object: {[key: string]: T}): {[key: string]: T};
-
-export = lowercaseKeys;
+export default function lowercaseKeys<T>(object: Record<string, T>, options?: Options<T>): Record<string, T>;

package/index.js

@@ -1,10 +1,22 @@
-'use strict';
-module.exports = object => {
+export default function lowercaseKeys(object, {onConflict} = {}) {
 	const result = {};
 
 	for (const [key, value] of Object.entries(object)) {
-		result[key.toLowerCase()] = value;
+		const lowercasedKey = key.toLowerCase();
+		const hasExistingKey = Object.hasOwn(result, lowercasedKey);
+		const existingValue = hasExistingKey ? result[lowercasedKey] : undefined;
+
+		const resolvedValue = onConflict && hasExistingKey
+			? onConflict({key: lowercasedKey, newValue: value, existingValue})
+			: value;
+
+		Object.defineProperty(result, lowercasedKey, {
+			value: resolvedValue,
+			writable: true,
+			enumerable: true,
+			configurable: true,
+		});
 	}
 
 	return result;
-};
+}

package/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,16 +1,23 @@
 {
 	"name": "lowercase-keys",
-	"version": "2.0.0",
+	"version": "4.0.0",
 	"description": "Lowercase the keys of an object",
 	"license": "MIT",
 	"repository": "sindresorhus/lowercase-keys",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
+	"type": "module",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=8"
+		"node": ">=20"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -31,8 +38,8 @@
 		"key"
 	],
 	"devDependencies": {
-		"ava": "^1.4.1",
-		"tsd": "^0.7.2",
-		"xo": "^0.24.0"
+		"ava": "^6.4.1",
+		"tsd": "^0.33.0",
+		"xo": "^1.2.3"
 	}
 }

package/readme.md

@@ -1,32 +1,57 @@
-# lowercase-keys [![Build Status](https://travis-ci.org/sindresorhus/lowercase-keys.svg?branch=master)](https://travis-ci.org/sindresorhus/lowercase-keys)
+# lowercase-keys
 
 > Lowercase the keys of an object
 
+Check out [`map-obj`](https://github.com/sindresorhus/map-obj) if you need support for deep iteration.
 
 ## Install
 
+```sh
+npm install lowercase-keys
 ```
-$ npm install lowercase-keys
-```
-
 
 ## Usage
 
 ```js
-const lowercaseKeys = require('lowercase-keys');
+import lowercaseKeys from 'lowercase-keys';
 
 lowercaseKeys({FOO: true, bAr: false});
 //=> {foo: true, bar: false}
 ```
 
-
 ## API
 
-### lowercaseKeys(object)
+### lowercaseKeys(object, options?)
 
 Returns a new object with the keys lowercased.
 
+#### options
+
+Type: `object`
+
+##### onConflict
 
-## License
+Type: `Function`
 
-MIT © [Sindre Sorhus](https://sindresorhus.com)
+A function that is called when multiple keys in the input object map to the same lowercased key.
+
+The function receives the lowercased key, the new value, and the existing value, and should return the value to use.
+
+By default, the last value wins.
+
+```js
+import lowercaseKeys from 'lowercase-keys';
+
+// Throw on conflict
+lowercaseKeys({Key: 'value1', key: 'value2'}, {
+	onConflict({key}) {
+		throw new Error(`Duplicate key: ${key}`);
+	}
+});
+
+// Keep the first value
+lowercaseKeys({Key: 'value1', key: 'value2'}, {
+	onConflict: ({existingValue}) => existingValue,
+});
+//=> {key: 'value1'}
+```