clarify what is path for unset

react-hook-form · May 19, 2024 · 8f4dc48 · 8f4dc48
1 parent cdec16d
commit 8f4dc48
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/utils/unset.ts b/src/utils/unset.ts
@@ -6,6 +6,7 @@ import stringToPath from './stringToPath';
 
 /**
  * Removes the property at `path` of `object`.
+ * @remarks `path` could be string or 'a.b.c' or 'a[0].b.c' whatever register() accepts
  * @example
  * const obj = { a: { b: { c: 42 } } };
  * unset(obj, 'a.b.c');