-
-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed nested options where not being merged together with default opt…
…ions
- Loading branch information
1 parent
c17b77c
commit 27ab4dc
Showing
8 changed files
with
124 additions
and
25 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
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
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
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
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
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
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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
/* eslint-disable security/detect-object-injection */ | ||
|
||
/** | ||
* Deep partial type that does NOT partial function arguments. | ||
*/ | ||
// eslint-disable-next-line @typescript-eslint/ban-types | ||
export type DeepPartial<T> = T extends Function ? T : (T extends object ? { [P in keyof T]?: DeepPartial<T[P]>; } : T); | ||
|
||
export function mergePartialAndDefault<T extends Record<string, any>>(defaultNonOptional: T, customOptional?: DeepPartial<T>): T { | ||
if (customOptional === undefined) { | ||
return defaultNonOptional; | ||
} | ||
// create a new object | ||
const target = {...defaultNonOptional} as Record<string, any>; | ||
|
||
// deep merge the object into the target object | ||
const merger = (obj: Record<string, any>) => { | ||
for (const [propName, prop] of Object.entries(obj)) { | ||
if (typeof prop === 'object') { | ||
if (target[propName] === undefined) { | ||
target[propName] = prop; | ||
} else { | ||
target[propName] = mergePartialAndDefault(target[propName], prop); | ||
} | ||
} else if (prop) { | ||
target[propName] = prop; | ||
} | ||
} | ||
}; | ||
merger(customOptional); | ||
return target as T; | ||
} |
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 |
---|---|---|
@@ -0,0 +1,68 @@ | ||
import {DeepPartial, mergePartialAndDefault} from '../../src/utils'; | ||
|
||
describe('mergePartialAndDefault', () => { | ||
test('should handle default objects', () => { | ||
interface TestType { | ||
nestedObject: { | ||
nested: string | ||
}, | ||
testProp: string | ||
} | ||
const defaultOptions: TestType = { | ||
nestedObject: { | ||
nested: 'test' | ||
}, | ||
testProp: 'test' | ||
}; | ||
const partialOptions: DeepPartial<TestType> = { | ||
testProp: 'test2' | ||
}; | ||
const realizedOptions = mergePartialAndDefault(defaultOptions, partialOptions) as TestType; | ||
expect(realizedOptions.testProp).toEqual('test2'); | ||
expect(realizedOptions.nestedObject.nested).toEqual('test'); | ||
}); | ||
test('should handle overwriting nested objects', () => { | ||
interface TestType { | ||
nestedObject: { | ||
nested: string | ||
} | ||
} | ||
const defaultOptions: TestType = { | ||
nestedObject: { | ||
nested: 'test' | ||
} | ||
}; | ||
const partialOptions: DeepPartial<TestType> = { | ||
nestedObject: { | ||
nested: 'test2' | ||
} | ||
}; | ||
const realizedOptions = mergePartialAndDefault(defaultOptions, partialOptions) as TestType; | ||
expect(realizedOptions.nestedObject.nested).toEqual('test2'); | ||
}); | ||
test('should not overwrite old realized options ', () => { | ||
interface TestType { | ||
nestedObject: { | ||
nested: string | ||
} | ||
} | ||
const defaultOptions: TestType = { | ||
nestedObject: { | ||
nested: 'test' | ||
} | ||
}; | ||
const partialOptions: DeepPartial<TestType> = { | ||
nestedObject: { | ||
nested: 'test2' | ||
} | ||
}; | ||
const partialOptions2: DeepPartial<TestType> = { | ||
nestedObject: { | ||
nested: 'test3' | ||
} | ||
}; | ||
const realizedOptions = mergePartialAndDefault(defaultOptions, partialOptions) as TestType; | ||
mergePartialAndDefault(defaultOptions, partialOptions2) as TestType; | ||
expect(realizedOptions.nestedObject.nested).toEqual('test2'); | ||
}); | ||
}); |