feat(utils): flatten 신규 유틸 함수 추가

[ssi02014]

Overview

Issue: #302

중첩 배열을 평탄화해주는 함수입니다. depth 옵션으로 평탄화 깊이를 직접 지정 할 수 있습니다.

JS에서 기본적으로 제공하는 Array.prototype.flat은 성능이 좋지 않습니다.

제공하는 flatten 함수는 JS의 flat과 lodash의 flattenDepth보다 성능적으로 우수합니다.

Example

해당 함수는 기존 Array.prototype.flat와 동일하게 depth 값에 따른 타입 추론을 원활하게 해줍니다

const arr = [1, [2, [3, [4, [5]]]]];

flatten(arr, 1); 
// value: [1, 2, [3, [4, [5]]]]
// type: (number | (number | (number | number[])[])[])[]

flatten(arr, 2); 
// value: [1, 2, 3, [4, [5]]]
// type: (number | (number | number[])[])[]

flatten(arr, 3); 
// value: [1, 2, 3, 4, [5]]
// type: (number | number[])[]

flatten(arr, 4); 
// value: [1, 2, 3, 4, 5]
// type: number[]

PR Checklist

• All tests pass.
• All type checks pass.
• I have read the Contributing Guide document.
  Contributing Guide

[changeset-bot]

🦋 Changeset detected

Latest commit: c879138

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@modern-kit/utils	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[ssi02014]

@Sangminnn 성능적으로 우수한 flatten 함수를 추가하고, 이를 기반으로 deepFlatThenMap과 더불어 flatMapDeep 을 개선하고자 합니다 🤗

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (c85b3f4) to head (cf09195).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #303      +/-   ##
==========================================
+ Coverage   96.88%   96.91%   +0.02%     
==========================================
  Files         123      124       +1     
  Lines        1284     1296      +12     
  Branches      312      315       +3     
==========================================
+ Hits         1244     1256      +12     
  Misses         34       34              
  Partials        6        6              

Components	Coverage Δ
@modern-kit/react	94.55% <ø> (ø)
@modern-kit/utils	100.00% <100.00%> (ø)

[ssi02014]

toss/es-toolkit#147
es-toolkit에 추가됐습니다 🎉