Enable flattening to a specified depth (continued) #2868
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a continuation of #2460 by @paulfalgout. The former boolean
shallow
parameter of both the internal and the externalflatten
is replaced by adepth
parameter which can be either boolean or numeric. Boolean values still have the same meaning. Numeric1
has the same meaning astrue
while0
or less results in a shallow copy without any flattening. The default is still infinite depth.@jashkenas The original PR was approved by @akre54 and @michaelficarra in 2016. If this is sufficiently reassuring for you, you can stop reading here.
@paulfalgout I moved your checks against nonnumeric and nonpositive
depth
values back from the public to the internalflatten
. At the time, you were concerned that this would be inconsistent withstrict === true
, but there is actually no conflict. Whendepth === 1
, every nested element of every array is copied whether the nested element is an array or not, even whenstrict === true
. Extrapolating this todepth === 0
, "every array" is just the top-level array, so every element of it should be copied, regardless of whether it is an array and regardless of the value ofstrict
.Merging this should automatically also merge #2460.