transformObject()function
transformObject(obj: T, transforms: Transforms<T, T | Partial<T>, A>, ...args: A): T
transformObject(obj: T | Partial<T>, transforms: Transforms<T, T | Partial<T>, A>, ...args: A): Partial<T>
transformObject(obj: I, transforms: Transforms<I, O | Partial<O>, A>, ...args: A): O
transformObject(obj: I | Partial<I>, transforms: Transforms<I, O | Partial<O>, A>, ...args: A): Partial<O>
| Param | Type | |
|---|---|---|
obj | T | The source object to transform. required |
transforms | Transforms<T, TPartial<T>, A> | Object of per-prop transform functions, keyed by prop name. required |
args | A | Additional arguments passed through to each transform. required |
obj | TPartial<T> | required |
transforms | Transforms<T, TPartial<T>, A> | required |
args | A | required |
obj | I | required |
transforms | Transforms<I, OPartial<O>, A> | required |
obj | IPartial<I> | required |
| Return | |
|---|---|
T | Transformed object (or same object if no changes were made). |
Partial<T> | |
O | |
Partial<O> |
Transform an object using a set of named transforms.
- Each transform is keyed by prop name and applied to that prop's current value.
- Props with no transform are left untouched; the original object is returned unchanged if no transform alters a value.
Examples
transformObject({ a: 1, b: 2 }, { a: n => n + 10 }) // { a: 11, b: 2 }