Skip to content

Commit 6c57fc8

Browse files
authored
Improve TypeScript types (#218)
1 parent c6db15a commit 6c57fc8

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

index.d.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
import {PackageJson} from 'type-fest';
1+
import {
2+
CamelCasedProperties,
3+
PackageJson,
4+
} from 'type-fest';
25

36
export type FlagType = 'string' | 'boolean' | 'number';
47

@@ -246,7 +249,7 @@ export interface Result<Flags extends AnyFlags> {
246249
/**
247250
Flags converted to camelCase excluding aliases.
248251
*/
249-
flags: TypedFlags<Flags> & Record<string, unknown>;
252+
flags: CamelCasedProperties<TypedFlags<Flags>> & Record<string, unknown>;
250253

251254
/**
252255
Flags converted camelCase including aliases.

index.test-d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ expectType<PackageJson>(result.pkg);
6464
expectType<string>(result.help);
6565

6666
expectType<boolean | undefined>(result.flags.foo);
67-
expectType<unknown>(result.flags.fooBar);
67+
expectType<number | undefined>(result.flags.fooBar);
6868
expectType<string>(result.flags.bar);
6969
expectType<string[] | undefined>(result.flags.abc);
7070
expectType<boolean | undefined>(result.unnormalizedFlags.foo);

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"read-pkg-up": "^8.0.0",
5353
"redent": "^4.0.0",
5454
"trim-newlines": "^4.0.2",
55-
"type-fest": "^1.2.2",
55+
"type-fest": "^3.1.0",
5656
"yargs-parser": "^20.2.9"
5757
},
5858
"devDependencies": {

0 commit comments

Comments
 (0)