@ptolemy2002/list-object-utils 2.0.0 → 2.0.1

package/README.md

@@ -119,18 +119,18 @@ Finds the difference between two objects, that is, the properties that do not ma
 #### Returns
 `ObjectOptional` - If the operands are both objects, an object with a property for every key at which the two objects differ. The value for each property is the value from the second object. If the operands are not both objects and equal, an empty object. If the operands are not both objects and not equal, the second operand.
 
-### flattenKeys
+### flattenKeys<T>
 #### Description
 For an object that contains properties that are also objects, this function will flatten the keys of the object to a single level. The keys will be concatenated with a period (`.`) between them. Also does this with lists. Uses recursion to flatten nested objects.
 
 Note that empty lists and empty objects are left as-is.
 
 #### Parameters
-- `obj` (`Object`): The object to be flattened.
+- `obj` (`T`): The object to be flattened.
 - `prefix` (`string`): The prefix to be added to the keys. Default is an empty string.
 
 #### Returns
-`Object` - The object with the keys flattened.
+`Record<string, ValueOf<T>>` - The object with the keys flattened.
 
 ### sortWithIndices<T>
 #### Description
@@ -155,7 +155,7 @@ A simple implementation of `JSON.stringify` that converts undefined values to `n
 `string` - The string representation of the object.
 
 ## Peer Dependencies
-This project does not have any peer dependencies, so it should work out of the box.
+- @ptolemy2002/ts-utils^1.2.0
 
 ## Commands
 The following commands exist in the project:

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ValueOf } from "@ptolemy2002/ts-utils";
 type ArrayOptional = any[] | null | undefined;
 type ObjectOptional = Object | null | undefined;
 export declare function listsEqual(a: ArrayOptional, b: ArrayOptional): boolean;
@@ -9,7 +10,7 @@ export declare function listSet<T>(list: T[], i: number, item: T): T[];
 export declare function isSet(list: any[]): boolean;
 export declare function listDifference(a: ArrayOptional, b: ArrayOptional): ObjectOptional;
 export declare function objectDifference(a: ObjectOptional, b: ObjectOptional): ObjectOptional;
-export declare function flattenKeys(obj: Object, prefix?: string): Object;
+export declare function flattenKeys<T>(obj: T, prefix?: string): Record<string, ValueOf<T>>;
 type SortCallback = (a: number, b: number) => number;
 export declare function sortWithIndeces<T>(toSort: T[], sort?: SortCallback, descending?: boolean): T[];
 export declare function objectToString(obj: Object): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/list-object-utils",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -8,9 +8,9 @@
         "/dist"
     ],
     "repository": {
-      "type": "git",
-      "url": "https://github.com/Ptolemy2002/list-object-utils",
-      "directory": "lib"
+        "type": "git",
+        "url": "https://github.com/Ptolemy2002/list-object-utils",
+        "directory": "lib"
     },
     "scripts": {
         "build": "tsc --project ./tsconfig.json",
@@ -26,5 +26,10 @@
         "release-minor": "bash ./scripts/release.sh minor",
         "release-major": "bash ./scripts/release.sh major"
     },
-    "devDependencies": {}
-}
+    "peerDependencies": {
+        "@ptolemy2002/ts-utils": "^1.2.0"
+    },
+    "devDependencies": {
+        "@ptolemy2002/ts-utils": "^1.2.0"
+    }
+}