feat: add objFindItemRecursiveByKey method

Author: jooy2

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.3.3 (2024--)
+
+- `objFindItemRecursiveByKey`: Add `objFindItemRecursiveByKey` method
+
 ## 1.3.2 (2023-12-28)
 
 - `strToNumberHash`: Add `strToNumberHash` method

docs/src/methods/object.md

@@ -44,3 +44,42 @@ Recursively output all the steps of the JSON object (`JSON.stringify`) and then
 ```javascript
 _.objToPrettyStr({ a: 1, b: { c: 1, d: 2 } }); // Returns '{\n\t"a": 1,\n\t"b": {\n\t\t"c": 1,\n\t\t"d": 2\n\t}\n}'
 ```
+
+## `_.objFindItemRecursiveByKey`
+
+Returns the object if the key of a specific piece of data in the object's dataset corresponds to a specific value. This function returns only one result, so it is used to search for unique IDs, including all of their children.
+
+### Parameters
+
+- `obj::object`
+- `searchKey::string`
+- `searchValue::any`
+- `childKey::string`
+
+### Returns
+
+> object|null
+
+### Examples
+
+```javascript
+_.objFindItemRecursiveByKey(
+	{
+		id: 123,
+		name: 'parent',
+		child: [
+			{
+				id: 456,
+				name: 'childItemA'
+			},
+			{
+				id: 789,
+				name: 'childItemB'
+			}
+		]
+	}, // obj
+	'id', // searchKey
+	456, // searchValue
+	'child' // childKey
+); // Returns '{ id: 456, name: 'childItemA' }'
+```

lib/index.ts

@@ -424,6 +424,39 @@ export default class Qsu {
 			.join('&');
 	}
 
+	static objFindItemRecursiveByKey(
+		obj: AnyValueObject | any[],
+		searchKey: string,
+		searchValue: any,
+		childKey: string
+	): AnyValueObject | null {
+		const findItemFromList = (lists: AnyValueObject): any | null => {
+			let searchArray: any[];
+
+			if (typeof lists !== 'object' || !Array.isArray(lists)) {
+				searchArray = [lists];
+			} else {
+				searchArray = lists;
+			}
+
+			for (let i = 0, iLen = searchArray.length; i < iLen; i += 1) {
+				if (searchArray[i][searchKey] === searchValue) {
+					return searchArray[i];
+				}
+				if (!Qsu.isEmpty(searchArray[i][childKey])) {
+					const childItem = findItemFromList(searchArray[i][childKey]);
+
+					if (childItem) {
+						return childItem;
+					}
+				}
+			}
+			return null;
+		};
+
+		return findItemFromList(obj);
+	}
+
 	static objToPrettyStr(obj: AnyValueObject): string {
 		return JSON.stringify(obj, null, '\t');
 	}
@@ -1038,6 +1071,7 @@ export const {
 	sortNumeric,
 	objToQueryString,
 	objToPrettyStr,
+	objFindItemRecursiveByKey,
 	trim,
 	replaceBetween,
 	removeSpecialChar,

test/object.spec.ts

@@ -1,5 +1,5 @@
 import assert from 'assert';
-import { objToQueryString, objToPrettyStr } from '../dist';
+import { objToQueryString, objToPrettyStr, objFindItemRecursiveByKey } from '../dist';
 
 describe('Misc', () => {
 	it('funcTimes', (done) => {
@@ -37,4 +37,97 @@ describe('Misc', () => {
 		);
 		done();
 	});
+
+	it('objFindItemRecursiveByKey', (done) => {
+		assert.deepStrictEqual(
+			objFindItemRecursiveByKey(
+				{
+					a: 1,
+					b: 2,
+					c: 3
+				},
+				'a',
+				123,
+				'child'
+			),
+			null
+		);
+		assert.deepStrictEqual(
+			objFindItemRecursiveByKey(
+				[
+					{
+						a: 1,
+						b: 2,
+						c: 3
+					},
+					{
+						a: 2,
+						b: 3,
+						c: 4
+					},
+					{
+						a: 3,
+						b: 4,
+						c: 5
+					},
+					{
+						a: 4,
+						b: 5,
+						c: 6
+					}
+				],
+				'a',
+				3,
+				'a'
+			),
+			{
+				a: 3,
+				b: 4,
+				c: 5
+			}
+		);
+		assert.deepStrictEqual(
+			objFindItemRecursiveByKey(
+				{
+					a: {
+						a: {
+							a: 123
+						}
+					},
+					b: {
+						a: {}
+					},
+					c: 3
+				},
+				'a',
+				123,
+				'a'
+			),
+			{
+				a: 123
+			}
+		);
+		assert.deepStrictEqual(
+			objFindItemRecursiveByKey(
+				{
+					id: 123,
+					child: [
+						{
+							id: 456
+						},
+						{
+							id: 789
+						}
+					]
+				},
+				'id',
+				456,
+				'child'
+			),
+			{
+				id: 456
+			}
+		);
+		done();
+	});
 });