Improve documentation

.editorconfig

@@ -4,7 +4,7 @@ root = true
 end_of_line = lf
 insert_final_newline = true
 
-[*.{js,json,md,yml}]
+[*.{ts,js,json,md,yml}]
 charset = utf-8
 indent_style = space
 indent_size = 2

readme.md

@@ -51,7 +51,7 @@ const response = await fetch("https://httpbin.org/post", options)
 
 ## API
 
-`objectToFormData(input[, options]): FormData`
+### `objectToFormData(input[, options]): FormData`
 
 Indicates whether or not to omit every `false` values. Applied enabled. Does not affect boolean array values
 
@@ -61,3 +61,28 @@ This function takes following arguments:
 |---------|:---------------------------------------------:|:---------:|:-----------:|----------------------------------|
 | input   | `unknown[] | Record<sting | number, unknown>` | true      | –           | An object to transform           |
 | options | `ObjectToFormDataOptions`                     | false     | `undefined` | Additional serialization options |
+
+### `interface ObjectToFormDataOptions`
+
+Serialization options
+
+| Name           | Type                 | Required | Default               | Description                               |
+|----------------|:--------------------:|:--------:|:---------------------:|-------------------------------------------|
+| strict         | `boolean`            | false    | `false`               | Indicates whether or not to omit every `false` values. Applied enabled. Does not affect boolean array values  |
+| FormData       | `FormData`           | false    | `globalThis.FormData` | Custom spec-compliant [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) implementation  |
+| notation       | `"dot" | "bracket"`  | false    | `"bracket"`           | Type of the path notation. Can be either `"dot"` or `"bracket"`                                               |
+| normalizeValue | `NormalizeValue`     | false    | undefined             | Value normalizer. This function will be called on each *scalar* value, before it's added to FormData instance |
+
+### `NormalizeValue`
+
+Value normalizer.
+
+This function will 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:
+
+| Name    | Type                     | Description                         |
+|---------|:------------------------:|-------------------------------------|
+| value   | `unknown`                | Current entry value                 |
+| name    | `string`                 | The name of the entry               |
+| path    | `Array<string | number>` | Entry's path within original object |

src/objectToFormData.ts

@@ -9,9 +9,9 @@ import type {Input} from "./Input.js"
  *
  * This function will be called on each *scalar* value, before it's added to FormData instanceю
  *
- * @param value - current entry value
- * @param name - name of the entry
- * @param path - entry's path within original object
+ * @param value - Current entry value
+ * @param name - The name of the entry
+ * @param path - Entry's path within original object
  */
 export type NormalizeValue = (
   value: unknown,
@@ -80,7 +80,7 @@ export interface ObjectToFormDataOptions {
   /**
    * Value normalizer.
    *
-   * This function will be called on each *scalar* value, before it's added to FormData instanceю
+   * This function will be called on each *scalar* value, before it's added to FormData instance.
    */
   normalizeValue?: NormalizeValue
 }