TypeScript - Fix return type for undefined defaultValue (#56)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
sindresorhus · Jun 12, 2019 · e0f8abf · e0f8abf
1 parent b8b7124
commit e0f8abf
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -21,10 +21,14 @@ declare const dotProp: {
 	//=> 'unicorn'
 	```
 	*/
+	get<T>(
+		object: {[key: string]: any},
+		path: string
+	): T | undefined;
 	get<T>(
 		object: {[key: string]: any},
 		path: string,
-		defaultValue?: T
+		defaultValue: T
 	): T;
 
 	/**

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -2,6 +2,7 @@ import {expectType} from 'tsd';
 import dotProp = require('.');
 
 expectType<unknown>(dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar'));
+expectType<string | undefined>(dotProp.get<string>({foo: {bar: 'unicorn'}}, 'foo.bar'));
 expectType<unknown>(dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep'));
 expectType<string>(
 	dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value')