Move allowUndefinedInNonTupleArrays option example in the option do…

…cumentation
sindresorhus · Dec 30, 2024 · d7184be · d7184be
1 parent 90fd588
commit d7184be
Showing 1 changed file with 13 additions and 14 deletions.
diff --git a/source/partial-deep.d.ts b/source/partial-deep.d.ts
@@ -15,6 +15,19 @@ export type PartialDeepOptions = {
     Allows undefined values in non-tuple arrays. When set to `true`, elements of non-tuple arrays can be `undefined`. When set to `false`, only explicitly defined elements are allowed in non-tuple arrays, ensuring stricter type checking. Defaults to `true` if not specified.
 
     @default true
+    @example
+    You can prevent undefined values in non tuple arrays by passing `{recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}` as the second type argument:
+
+```
+interface Settings {
+	languages: string[];
+}
+
+const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}> = {
+	languages: [undefined] 	// Error
+	languages: []		// OK
+};
+```
 	*/
 	readonly allowUndefinedInNonTupleArrays?: boolean;
 };
@@ -60,20 +73,6 @@ const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true}> = {
 	languages: [undefined]
 };
 ```
-You can prevent undefined values in non tuple arrays by passing `{recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}` as the second type argument:
-
-```
-import type {PartialDeep} from 'type-fest';
-
-interface Settings {
-	languages: string[];
-}
-
-const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}> = {
-	languages: [undefined] 	// Error
-	languages: []		// OK
-};
-```
 
 @category Object
 @category Array