WIP: Typescript definitions

[bambeusz]

set function needs improvement. I'm not even sure it is possible to make it in typescript definition files.

Problem:
The path parameter might be a string, which contains of keys, separated with dot. We'd need to define n-level nesting (Where n = numberOfDots + 1) in ImmutableSetReturnFromPathString type somehow. Perhaps it would be a good idea to implement this method in typescript itself, and - if needed - slightly modify it, in order for it to be more "typed-way". wdyt?

Another story is: what if a user wants (for GodKnowsWhy reason), to have resulting object with key, that contains a dot e.g.

{
  foo: {
    bar: {
      'baz.zar': 'a value',
    }
  }
}

Is there a way to do that using set method?

[Lukasz-pluszczewski]

Regarding your questions:

1. number of elements (levels) in path may not be necessarily be equal to numberOfDots + 1, as array-like syntax is supported:
   foo.bar[1][2][baz].lorem[ipsum]
   You could just (if it's even possible) implement src/stringToPath.js function in typescript. It returns an array of strings or numbers (in case of numeric array-like path elements). The length of that array is n value you are looking for
2. if there is a field with dot in nested structure it is not going to work correctly (set would create new field). I am not able to differentiate those two situations:

foo : {
  'bar.baz': 'value',
}

foo: {
  bar: {
    baz: 'value',
  },
}