type-fest 5.3.1 → 5.4.1

package/source/tuple-to-object.d.ts

@@ -13,27 +13,27 @@ Note: Tuple labels are [lost in the transformation process](https://stackoverflo
 import type {TupleToObject} from 'type-fest';
 
 type Example1 = TupleToObject<[number, string, boolean]>;
-//=> { 0: number; 1: string; 2: boolean }
+//=> {0: number; 1: string; 2: boolean}
 
 // Tuples with optional indices
 type Example2 = TupleToObject<[number, string?, boolean?]>;
-//=> { 0: number; 1?: string; 2?: boolean }
+//=> {0: number; 1?: string; 2?: boolean}
 
 // Readonly tuples
 type Example3 = TupleToObject<readonly [number, string?]>;
-//=> { readonly 0: number; readonly 1?: string }
+//=> {readonly 0: number; readonly 1?: string}
 
 // Non-tuple arrays get transformed into index signatures
 type Example4 = TupleToObject<string[]>;
-//=> { [x: number]: string }
+//=> {[x: number]: string}
 
 // Tuples with rest elements
 type Example5 = TupleToObject<[number, string, ...boolean[]]>;
-//=> { [x: number]: number | string | boolean; 0: number; 1: string }
+//=> {[x: number]: string | number | boolean; 0: number; 1: string}
 
 // Tuple labels are not preserved
 type Example6 = TupleToObject<[x: number, y: number]>;
-//=> { 0: number; 1: number }
+//=> {0: number; 1: number}
 ```
 
 @category Array

package/source/tuple-to-union.d.ts

@@ -39,7 +39,7 @@ const erroringType = new Set(['a', 'b', 'c']);
 
 // @ts-expect-error
 type ErroringType = typeof erroringType[number];
-//=> Type 'Set<string>' has no matching index signature for type 'number'. ts(2537)
+// Error: Type 'Set<string>' has no matching index signature for type 'number'. ts(2537)
 
 const numberBool: {[n: number]: boolean} = {1: true};
 

package/source/union-to-intersection.d.ts

@@ -10,7 +10,7 @@ import type {UnionToIntersection} from 'type-fest';
 type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};
 
 type Intersection = UnionToIntersection<Union>;
-//=> {the(): void; great(arg: string): void; escape: boolean};
+//=> {the(): void} & {great(arg: string): void} & {escape: boolean}
 ```
 
 @category Type

package/source/unknown-record.d.ts

@@ -11,18 +11,18 @@ function toJson(object: UnknownRecord) {
 	return JSON.stringify(object);
 }
 
-toJson({hello: 'world'});
-//=> '{"hello":"world"}'
+toJson({hello: 'world'}); // Ok
 
 function isObject(value: unknown): value is UnknownRecord {
 	return typeof value === 'object' && value !== null;
 }
 
-isObject({hello: 'world'});
-//=> true
+const value: unknown = {hello: 'world'};
 
-isObject('hello');
-//=> false
+if (isObject(value)) {
+	const v = value;
+	//=> UnknownRecord
+}
 ```
 
 @category Type

package/source/unwrap-partial.d.ts

@@ -0,0 +1,33 @@
+/**
+Revert the `Partial` modifier on an object type.
+
+Use-case: Infer the underlying type `T` when only `Partial<T>` is available or the original type may not be directly accessible.
+
+@example
+```
+import type {UnwrapPartial} from 'type-fest';
+
+type Config = Partial<{
+	port: number;
+	host: string;
+	secure?: boolean;
+}>;
+
+type InitializedConfig = UnwrapPartial<Config>;
+//=> {port: number; host: string; secure?: boolean}
+```
+
+Note: If the provided type isn’t of `Partial<T>`, `UnwrapPartial` has no effect on the original type.
+
+@category Object
+*/
+export type UnwrapPartial<PartialObjectType> =
+	PartialObjectType extends Partial<infer ObjectType>
+		? (
+			Partial<ObjectType> extends PartialObjectType
+				? ObjectType
+				: PartialObjectType
+		)
+		: PartialObjectType;
+
+export {};

package/source/value-of.d.ts

@@ -8,13 +8,13 @@ Please upvote [this issue](https://github.com/microsoft/TypeScript/issues/31438)
 import type {ValueOf} from 'type-fest';
 
 type A = ValueOf<{id: number; name: string; active: boolean}>;
-//=> number | string | boolean
+//=> string | number | boolean
 
 type B = ValueOf<{id: number; name: string; active: boolean}, 'name'>;
 //=> string
 
 type C = ValueOf<{id: number; name: string; active: boolean}, 'id' | 'name'>;
-//=> number | string
+//=> string | number
 ```
 
 @category Object

package/source/words.d.ts

@@ -31,10 +31,10 @@ export type WordsOptions = {
 	import type {Words} from 'type-fest';
 
 	type Example1 = Words<'p2pNetwork', {splitOnNumbers: true}>;
-	//=> ["p", "2", "p", "Network"]
+	//=> ['p', '2', 'p', 'Network']
 
 	type Example2 = Words<'p2pNetwork', {splitOnNumbers: false}>;
-	//=> ["p2p", "Network"]
+	//=> ['p2p', 'Network']
 	```
 	*/
 	splitOnNumbers?: boolean;