elrh-cosca 0.2.6 → 0.2.8

package/README.md

@@ -66,18 +66,34 @@ The merger is performed using [unjs/magicast](https://github.com/unjs/magicast).
 - create a unique-union in case of arrays
 Please [report](https://github.com/AloisSeckar/elrh-cosca/issues) any logical flaws and issues of the process.
 
+**Warning**: The function will fail, if the extracted object is proxied (e.g. when created using `defu`). In such case, the error would be:
+
+```
+TypeError: 'set' on proxy: trap returned falsish for property '<YOUR_PROPERTY>'
+```
+
+If possible, you need to alter your logic, e.g. by creating a new object via the spread operator.
+
+
 By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts. Passsing a custom `prompt` allows tailoring your own question to the user.
 
 #### `updateJsonFile`
 
 ```ts
 async function updateJsonFile(
-  pathToFile: string, jsonKey: string, newValues: Record<string | number | symbol, any>, 
+  pathToFile: string, jsonKey: string, patch: JsonValue, 
   force: boolean = false, prompt: string = ''
 ): Promise<void>
 ```
 
-Takes a path to a JSON file and injects `newValues` under `jsonKey` key.
+Takes a path to a JSON file and injects `patch` under `jsonKey` key. A `patch` is of `JsonValue` - a custom type defined as follows:
+
+```ts
+type JsonPrimitive = string | number | boolean | null
+type JsonObject = { [key: string]: JsonValue }
+type JsonArray = JsonValue[]
+type JsonValue = JsonPrimitive | JsonObject | JsonArray
+```
 
 Path to `targetFile` is relative to `process.cwd()`. The file must be a valid JSON file. It is parsed using plain `JSON.parse`.