@augment-vir/core 31.57.5 → 31.59.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,4 +1,19 @@
|
|
|
1
1
|
import { type AnyObject } from './generic-object-type.js';
|
|
2
|
+
import { type Values } from './object-value-types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Optional comparison parameter type for {@link sortObject}.
|
|
5
|
+
*
|
|
6
|
+
* @category Object
|
|
7
|
+
* @category Package : @augment-vir/common
|
|
8
|
+
* @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
|
|
9
|
+
*/
|
|
10
|
+
export type SortObjectComparison<T extends AnyObject> = (a: {
|
|
11
|
+
key: keyof T;
|
|
12
|
+
value: Values<T>;
|
|
13
|
+
}, b: {
|
|
14
|
+
key: keyof T;
|
|
15
|
+
value: Values<T>;
|
|
16
|
+
}) => number;
|
|
2
17
|
/**
|
|
3
18
|
* Creates as new sorted object copied from the the original given object.
|
|
4
19
|
*
|
|
@@ -6,4 +21,9 @@ import { type AnyObject } from './generic-object-type.js';
|
|
|
6
21
|
* @category Package : @augment-vir/common
|
|
7
22
|
* @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
|
|
8
23
|
*/
|
|
9
|
-
export declare function sortObject<const T extends AnyObject>(original: Readonly<T
|
|
24
|
+
export declare function sortObject<const T extends AnyObject>(original: Readonly<T>,
|
|
25
|
+
/**
|
|
26
|
+
* A custom comparison for the sort. By default, only the keys are sorted with default string
|
|
27
|
+
* sorting.
|
|
28
|
+
*/
|
|
29
|
+
comparison?: SortObjectComparison<T> | undefined): T;
|
|
@@ -5,10 +5,15 @@
|
|
|
5
5
|
* @category Package : @augment-vir/common
|
|
6
6
|
* @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
|
|
7
7
|
*/
|
|
8
|
-
export function sortObject(original
|
|
9
|
-
|
|
8
|
+
export function sortObject(original,
|
|
9
|
+
/**
|
|
10
|
+
* A custom comparison for the sort. By default, only the keys are sorted with default string
|
|
11
|
+
* sorting.
|
|
12
|
+
*/
|
|
13
|
+
comparison) {
|
|
14
|
+
return recursivelySortObject(original, new Map(), comparison);
|
|
10
15
|
}
|
|
11
|
-
function recursivelySortObject(original, seen) {
|
|
16
|
+
function recursivelySortObject(original, seen, comparison) {
|
|
12
17
|
if (original && typeof original === 'object' && !Array.isArray(original)) {
|
|
13
18
|
if (seen.has(original)) {
|
|
14
19
|
return seen.get(original);
|
|
@@ -17,9 +22,16 @@ function recursivelySortObject(original, seen) {
|
|
|
17
22
|
const sortedClone = {};
|
|
18
23
|
seen.set(original, sortedClone);
|
|
19
24
|
Object.entries(original)
|
|
20
|
-
.sort((a, b) =>
|
|
25
|
+
.sort((a, b) => {
|
|
26
|
+
if (comparison) {
|
|
27
|
+
return comparison({ key: a[0], value: a[1] }, { key: b[0], value: b[1] });
|
|
28
|
+
}
|
|
29
|
+
else {
|
|
30
|
+
return a[0].localeCompare(b[0]);
|
|
31
|
+
}
|
|
32
|
+
})
|
|
21
33
|
.forEach(([key, value,]) => {
|
|
22
|
-
const mappedValue = recursivelySortObject(value, seen);
|
|
34
|
+
const mappedValue = recursivelySortObject(value, seen, comparison);
|
|
23
35
|
sortedClone[key] = mappedValue;
|
|
24
36
|
});
|
|
25
37
|
return sortedClone;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@augment-vir/core",
|
|
3
|
-
"version": "31.
|
|
3
|
+
"version": "31.59.0",
|
|
4
4
|
"description": "Core augment-vir augments. Use @augment-vir/common instead.",
|
|
5
5
|
"homepage": "https://github.com/electrovir/augment-vir",
|
|
6
6
|
"bugs": {
|
|
@@ -30,9 +30,9 @@
|
|
|
30
30
|
"dependencies": {
|
|
31
31
|
"@date-vir/duration": "^8.1.0",
|
|
32
32
|
"browser-or-node": "^3.0.0",
|
|
33
|
-
"diff": "^8.0.
|
|
33
|
+
"diff": "^8.0.3",
|
|
34
34
|
"json5": "^2.2.3",
|
|
35
|
-
"type-fest": "^5.
|
|
35
|
+
"type-fest": "^5.4.1"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"@types/node": "^25.0.3",
|