Fix documentation for NormalizeValue

octet-stream · Mar 12, 2024 · c4b749b · c4b749b
1 parent f26ee28
commit c4b749b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/.changeset/mean-pumpkins-hug.md b/.changeset/mean-pumpkins-hug.md
@@ -0,0 +1,5 @@
+---
+"@octetstream/object-to-form-data": patch
+---
+
+Fix documentation for NormalizeValue
diff --git a/readme.md b/readme.md
@@ -211,11 +211,11 @@ Serialization options
 | notation       | `"dot" \| "bracket"`                     | false    | `"bracket"`           | Type of the nested fields notation. Can be either `"dot"` or `"bracket"`                                      |
 | normalizeValue | [`NormalizeValue`](#type-normalizevalue) | false    | `undefined`           | Value normalizer. This function will be called on each *scalar* value, before it's added to FormData instance |
 
-### `type NormalizeValue`
+### `interface NormalizeValue`
 
 Value normalizer.
 
-Will be called on each *scalar* value, before it's added to FormData instance. It **must** return either `Blob` or `string`
+A function to be called on each *scalar* value, before it's added to FormData instance. It **must** return either `Blob` or `string`
 
 This function will be called with the following arguments: