Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: not recursively camelCase keys in nested objects when using union with null #119

Merged
merged 2 commits into from
Oct 18, 2023
Merged

fix: not recursively camelCase keys in nested objects when using union with null #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b373953
fix: not recursively camelCase keys in nested objects when using unio…
yutak23 Oct 18, 2023
5326744
Update index.d.ts
sindresorhus Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ import type {CamelCase, PascalCase} from 'type-fest';
// eslint-disable-next-line @typescript-eslint/ban-types
type EmptyTuple = [];

type ObjectOptional = Record<string, unknown> | undefined;
// Allow union with, for example, `undefined` and `null`.
type ObjectUnion = Record<string, unknown> | unknown;

/**
Return a default type if input type is nil.
Expand Down Expand Up @@ -38,7 +39,7 @@ type AppendPath<S extends string, Last extends string> = S extends ''
Convert keys of an object to camelcase strings.
*/
export type CamelCaseKeys<
T extends ObjectOptional | readonly any[],
T extends ObjectUnion | readonly any[],
Deep extends boolean = false,
IsPascalCase extends boolean = false,
PreserveConsecutiveUppercase extends boolean = false,
Expand Down Expand Up @@ -71,7 +72,7 @@ export type CamelCaseKeys<
]
? T[P]
: [Deep] extends [true]
? T[P] extends ObjectOptional | readonly any[]
? T[P] extends ObjectUnion | readonly any[]
? CamelCaseKeys<
T[P],
Deep,
Expand Down
13 changes: 13 additions & 0 deletions index.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,3 +471,16 @@ function camelcaseKeysPascalCase<

expectType<{fooBar: {hogeHoge: string}}>(camelcaseKeysDeep({foo_bar: {hoge_hoge: 'hoge_hoge'}}));
expectType<{FooBar: string}>(camelcaseKeysPascalCase({foo_bar: 'foo_bar'}));

// Test for union type
// eslint-disable-next-line @typescript-eslint/ban-types
const objectCamelcased: CamelCaseKeys<{foo_bar: {foo_prop: string} | null}, true>
= camelcaseKeys({foo_bar: {foo_prop: 'foo_props'}}, {deep: true});
// eslint-disable-next-line @typescript-eslint/ban-types
const nullCamelcased: CamelCaseKeys<{foo_bar: {foo_prop: string} | null}, true>
= camelcaseKeys({foo_bar: null}, {deep: true});

// eslint-disable-next-line @typescript-eslint/ban-types
expectType<{fooBar: {fooProp: string} | null}>(objectCamelcased);
// eslint-disable-next-line @typescript-eslint/ban-types
expectType<{fooBar: {fooProp: string} | null}>(nullCamelcased);