Get: Optimize performance

[Emiyaaaaa]

Limit suggestions to 'a.b.c' to optimize performance. That is enough for most cases.

[marcomuser]

Even with this change it will remain configurable by passing in Paths generic with a higher maxRecursionDepth, right? I need a higher maxRecursionDepth than 2. :)

[sindresorhus]

This also should be done in v5. And if we decide to do it, it must be possible to increase it. I'm just wondering whether the performance increase is worth the inconvenience of potentially not having all things work directly with Get without having to set an option.

[som-sm]

This is not a breaking change like #1029 since it just affects the autocomplete. The second type argument continues to accept any string, just the autocomplete suggestions reduce to only depth: 2, which is fine IMO.

Current behaviour:

type Test = Get<{a: {b: {c: {d: string}}}}, 'a.b.d.e.f.g.h.i.j'>; // Valid

Updated behaviour:

type Test = Get<{a: {b: {c: {d: string}}}}, 'a.b.d.e.f.g.h.i.j'>; // Still Valid

Just the autocomplete suggestions reduce:

[som-sm]

I'm just wondering whether the performance increase is worth the inconvenience of potentially not having all things work directly with Get without having to set an option.

@sindresorhus I think there's some confusion, everything will still continue to work, right? The second type argument still effectively accepts any string.

And if we decide to do it, it must be possible to increase it.

Not sure, if we really need an option to control the autocomplete behaviour. The way it's used in the JSDoc example (which I feel is how this would mostly be used), the autocomplete is anyways not dependent on our code but on user's code.

// `Path` here decides the autocomplete behaviour
const get = <BaseType, Path extends string | readonly string[]>(object: BaseType, path: Path): Get<BaseType, Path> =>
	lodash.get(object, path);

[sindresorhus]

Ah, I didn't realize this is only about auto-complete. Then it's totally fine.

[Emiyaaaaa]

Even with this change it will remain configurable by passing in Paths generic with a higher maxRecursionDepth, right? I need a higher maxRecursionDepth than 2. :)

sure