From aedb3fb0189d52dda5cbb1589d09f4124fbee29b Mon Sep 17 00:00:00 2001 From: Jinwoo Lee Date: Thu, 16 Nov 2017 14:11:03 -0800 Subject: [PATCH] [package-json] fix wrong return type I made a mistake in my original PR https://github.com/DefinitelyTyped/DefinitelyTyped/pull/21578 The function should return a promise. - https://www.npmjs.com/package/package-json - https://github.com/sindresorhus/package-json/blob/master/index.js#L30 --- types/package-json/index.d.ts | 2 +- types/package-json/package-json-tests.ts | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/types/package-json/index.d.ts b/types/package-json/index.d.ts index bfa8e17bb6..e57902875b 100644 --- a/types/package-json/index.d.ts +++ b/types/package-json/index.d.ts @@ -9,6 +9,6 @@ interface PackageJsonOptions { allVersions?: boolean; } -declare function packageJson(name: string, options?: PackageJsonOptions): {}; +declare function packageJson(name: string, options?: PackageJsonOptions): Promise<{}>; export = packageJson; diff --git a/types/package-json/package-json-tests.ts b/types/package-json/package-json-tests.ts index c10ef298ac..98f14b1192 100644 --- a/types/package-json/package-json-tests.ts +++ b/types/package-json/package-json-tests.ts @@ -1,7 +1,10 @@ import packageJson = require('package-json'); -const pkg = packageJson('package-json', { +let pkg: {}; +packageJson('package-json', { version: '1.2.3', fullMetadata: true, allVersions: true, +}).then(x => { + pkg = x; });