docs: add important JSDoc note

zardoy · zardoy · commit fc4c3b85be09 · 2021-06-10T12:41:23.000Z
diff --git a/src/index.ts b/src/index.ts
@@ -73,7 +73,7 @@ const loadJsonFile = async (filePath: string, { encoding, tabSize }: Pick<Option
  * modifies **original** JSON file
  * You can pass generic, that reflects the structure of original JSON file
  * 
- * @param modifyFields Function setter or fields to merge
+ * @param modifyFields Fields to merge or callback (can be async). If callback is passed, JSON fields won't be merged.
  */
 export const modifyJsonFile: ModifyJsonFileGenericFunction = async (
     path,

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ const loadJsonFile = async (filePath: string, { encoding, tabSize }: Pick<Option`
`73`	`73`	`* modifies original JSON file`
`74`	`74`	`* You can pass generic, that reflects the structure of original JSON file`
`75`	`75`	`*`
`76`		`- * @param modifyFields Function setter or fields to merge`
	`76`	`+ * @param modifyFields Fields to merge or callback (can be async). If callback is passed, JSON fields won't be merged.`
`77`	`77`	`*/`
`78`	`78`	`export const modifyJsonFile: ModifyJsonFileGenericFunction = async (`
`79`	`79`	`path,`