Skip to content

Commit 6fee116

Browse files
authored
fix: typescript declarations (#189)
- add override for string version of function - fix default export error in Typescript 3.9
1 parent 34689d5 commit 6fee116

File tree

1 file changed

+30
-18
lines changed

1 file changed

+30
-18
lines changed

index.d.ts

+30-18
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,38 @@
11
/* eslint-disable @typescript-eslint/no-explicit-any */
22

3-
/**
4-
Sort packageJson.
3+
declare namespace sortPackageJsonExports {
4+
interface SortPackageJsonFn {
5+
/**
6+
* Sort packageJson object.
7+
*
8+
* @param packageJson - A packageJson
9+
* @param options
10+
* @returns Sorted packageJson object
11+
*/
12+
<T extends Record<any, any>>(packageJson: T, options?: Options): T,
13+
14+
/**
15+
* Sort packageJson string.
16+
*
17+
* @param packageJson - A packageJson string.
18+
* @param options
19+
* @returns Sorted packageJson string.
20+
*/
21+
(packageJson: string, options?: Options): string,
22+
}
523

6-
@param packageJson - A packageJson object or string.
7-
@param options
8-
@returns Sorted packageJson object or string.
9-
*/
10-
declare function sortPackageJsonCore<T extends Record<any, any>>(packageJson: T, options?: sortPackageJsonCore.Options): T;
11-
declare namespace sortPackageJsonCore {
12-
var sortPackageJson: <T extends Record<any, any>>(packageJson: T, options?: sortPackageJsonCore.Options) => T;
13-
// @ts-ignore
14-
var default: <T extends Record<any, any>>(packageJson: T, options?: sortPackageJsonCore.Options) => T;
15-
}
16-
declare namespace sortPackageJsonCore {
1724
type ComparatorFunction = (left: string, right: string) => number;
25+
1826
interface Options {
1927
readonly sortOrder?: readonly string[] | ComparatorFunction;
2028
}
21-
/**
22-
Default sort order.
23-
*/
24-
const sortOrder: readonly string[];
2529
}
26-
export = sortPackageJsonCore;
30+
31+
interface sortPackageJsonExports extends sortPackageJsonExports.SortPackageJsonFn {
32+
readonly default: sortPackageJsonExports.SortPackageJsonFn;
33+
readonly sortPackageJson: sortPackageJsonExports.SortPackageJsonFn;
34+
}
35+
36+
declare const sortPackageJsonExports: sortPackageJsonExports;
37+
38+
export = sortPackageJsonExports;

0 commit comments

Comments
 (0)