rambdax/_ts-toolbelt/src/Object/P/Update.ts

Extended version of Rambda - a lightweight, faster alternative to Ramda

import {IterationOf} from '../../Iteration/IterationOf'
import {Iteration} from '../../Iteration/Iteration'
import {Pos} from '../../Iteration/Pos'
import {Next} from '../../Iteration/Next'
import {Key} from '../../Any/Key'
import {LastIndex} from '../../List/LastIndex'
import {List} from '../../List/List'
import {Record} from '../Record'
import {Patch} from '../Patch'

/**
@hidden
*/
type _Update<O, Path extends List<Key>, A, I extends Iteration = IterationOf<'0'>> =
  O extends object                                                     // if it's an object
  ? Pos<I> extends LastIndex<Path>                                     // if it's the last index
    ? Patch<Record<Path[Pos<I>], A>, O>                                // use standard Update
    : (O & Record<Exclude<Path[Pos<I>], keyof O>, {}>) extends infer O // fill in missing keys with non-object
      ? {                                                              // to effectively build the object up
          [K in keyof O]: K extends Path[Pos<I>]                       // if K is part of path
                          ? _Update<O[K], Path, A, Next<I>>            // keep diving
                          : O[K]                                       // not part of path - x
        } & {}
      : never
  : O

/**
Update in `O` the fields at `Path` with `A`
@param O to update
@param Path to be followed
@param A to update with
@returns [[Object]]
@example
```ts
```
*/
export type Update<O extends object, Path extends List<Key>, A extends any> =
    _Update<O, Path, A>