-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: modernize type declarations (#299)
- Loading branch information
Showing
1 changed file
with
25 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,33 @@ | ||
/* eslint-disable @typescript-eslint/no-explicit-any */ | ||
|
||
declare namespace sortPackageJson { | ||
interface SortPackageJsonFn { | ||
/** | ||
* Sort packageJson object. | ||
* | ||
* @param packageJson - A packageJson | ||
* @param options - An options object | ||
* @returns Sorted packageJson object | ||
*/ | ||
<T extends Record<any, any>>(packageJson: T, options?: Options): T | ||
type ComparatorFunction = (left: string, right: string) => number | ||
|
||
/** | ||
* Sort packageJson string. | ||
* | ||
* @param packageJson - A packageJson string. | ||
* @param options - An options object | ||
* @returns Sorted packageJson string. | ||
*/ | ||
(packageJson: string, options?: Options): string | ||
} | ||
|
||
type ComparatorFunction = (left: string, right: string) => number | ||
|
||
function sortObjectBy<T extends Record<any, any>>( | ||
comparator?: string[], | ||
deep?: boolean, | ||
): (x: T) => T | ||
|
||
interface Field { | ||
readonly key: string | ||
over?<T extends Record<any, any>>(x: T): T | ||
} | ||
|
||
interface Options { | ||
readonly sortOrder?: readonly string[] | ComparatorFunction | ||
} | ||
interface Options { | ||
readonly sortOrder?: readonly string[] | ComparatorFunction | ||
} | ||
|
||
interface sortPackageJsonExports extends sortPackageJson.SortPackageJsonFn { | ||
readonly default: sortPackageJson.SortPackageJsonFn | ||
readonly sortPackageJson: sortPackageJson.SortPackageJsonFn | ||
readonly sortOrder: string[] | ||
interface SortPackageJson { | ||
/** | ||
* Sort packageJson object. | ||
* | ||
* @param packageJson - A packageJson | ||
* @param options - An options object | ||
* @returns Sorted packageJson object | ||
*/ | ||
<T extends Record<any, any>>(packageJson: T, options?: Options): T | ||
|
||
/** | ||
* Sort packageJson string. | ||
* | ||
* @param packageJson - A packageJson string. | ||
* @param options - An options object | ||
* @returns Sorted packageJson string. | ||
*/ | ||
(packageJson: string, options?: Options): string | ||
} | ||
|
||
declare const sortPackageJsonExports: sortPackageJsonExports | ||
declare const sortPackageJsonDefault: SortPackageJson | ||
export default sortPackageJsonDefault | ||
|
||
export = sortPackageJsonExports | ||
export const sortPackageJson: SortPackageJson | ||
export const sortOrder: string[] |