From f31b54d5b7b33b8d5385a87c7db5fd8a69c915fc Mon Sep 17 00:00:00 2001 From: Saad Quadri Date: Sun, 13 May 2018 17:09:06 -0400 Subject: [PATCH 1/2] cosmiconfig options should be optional --- types/cosmiconfig/cosmiconfig-tests.ts | 2 ++ types/cosmiconfig/index.d.ts | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/types/cosmiconfig/cosmiconfig-tests.ts b/types/cosmiconfig/cosmiconfig-tests.ts index 632569c6f9..73010d01ac 100644 --- a/types/cosmiconfig/cosmiconfig-tests.ts +++ b/types/cosmiconfig/cosmiconfig-tests.ts @@ -11,6 +11,8 @@ const explorer = cosmiconfig("yourModuleName", { ignoreEmptySearchPlaces: false, }); +const explorer2 = cosmiconfig("yourModuleName"); + Promise.all([ explorer.search(path.join(__dirname)), explorer.searchSync(path.join(__dirname)), diff --git a/types/cosmiconfig/index.d.ts b/types/cosmiconfig/index.d.ts index bdafc922ec..e8fd3fed17 100644 --- a/types/cosmiconfig/index.d.ts +++ b/types/cosmiconfig/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/davidtheclark/cosmiconfig // Definitions by: ozum // szeck87 +// saadq // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 @@ -55,4 +56,4 @@ export interface ExplorerOptions { ignoreEmptySearchPlaces?: boolean; } -export default function cosmiconfig(moduleName: string, options: ExplorerOptions): Explorer; +export default function cosmiconfig(moduleName: string, options?: ExplorerOptions): Explorer; From e3cfa5348b8cc1b1afcf28de4cf1f03801de9c50 Mon Sep 17 00:00:00 2001 From: saadq Date: Sun, 13 May 2018 17:53:05 -0400 Subject: [PATCH 2/2] add optional types to other explorer methods --- types/cosmiconfig/cosmiconfig-tests.ts | 2 ++ types/cosmiconfig/index.d.ts | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/types/cosmiconfig/cosmiconfig-tests.ts b/types/cosmiconfig/cosmiconfig-tests.ts index 73010d01ac..508ad00aa0 100644 --- a/types/cosmiconfig/cosmiconfig-tests.ts +++ b/types/cosmiconfig/cosmiconfig-tests.ts @@ -14,7 +14,9 @@ const explorer = cosmiconfig("yourModuleName", { const explorer2 = cosmiconfig("yourModuleName"); Promise.all([ + explorer.search(), explorer.search(path.join(__dirname)), + explorer.searchSync(), explorer.searchSync(path.join(__dirname)), explorer.load(path.join(__dirname, "sample-config.json")), explorer.loadSync(path.join(__dirname, "sample-config.json")), diff --git a/types/cosmiconfig/index.d.ts b/types/cosmiconfig/index.d.ts index e8fd3fed17..eb876b6ef2 100644 --- a/types/cosmiconfig/index.d.ts +++ b/types/cosmiconfig/index.d.ts @@ -36,8 +36,8 @@ export interface Loaders { } export interface Explorer { - search(searchFrom: string): Promise; - searchSync(searchFrom: string): null | CosmiconfigResult; + search(searchFrom?: string): Promise; + searchSync(searchFrom?: string): null | CosmiconfigResult; load(loadPath: string): Promise; loadSync(loadPath: string): CosmiconfigResult; clearLoadCache(): void;