Skip to content

Commit

Permalink
Improve documentation for options.notation
Browse files Browse the repository at this point in the history
  • Loading branch information
octet-stream committed Feb 18, 2024
1 parent e18099b commit 8817b09
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Serialization options
|----------------|:----------------------------------------:|:--------:|:---------------------:|---------------------------------------------------------------------------------------------------------------|
| 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"` |
| 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`
Expand Down
2 changes: 1 addition & 1 deletion src/objectToFormData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export interface ObjectToFormDataOptions {
FormData?: typeof FormData

/**
* Type of the path notation. Can be either `"dot"` or `"bracket"`
* Type of the nested fields notation. Can be either `"dot"` or `"bracket"`
*
* @default "bracket"
*/
Expand Down

0 comments on commit 8817b09

Please sign in to comment.