feat(initial): add initial

[minchodang]

close #151 #95

description

I have created a function that returns a new array containing all elements except the last one from the input array.
Below is a performance comparison with Lodash. If you have any questions or comments, please feel free to share.

Thank you.

benchmark

[vercel]

@minchodang is attempting to deploy a commit to the Toss Team on Vercel.

A member of the Team first needs to authorize it.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6606d5b) to head (7a93924).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #188   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           78        79    +1     
  Lines          427       431    +4     
  Branches        59        60    +1     
=========================================
+ Hits           427       431    +4     

[raon0211]

Suggested change

	import { bench, describe } from 'vitest';
	import { initial as lodashInitial } from 'lodash';
	import { initial as esToolkitInitial } from 'es-toolkit'; // hypothetical library
	// Helper function to generate a large array
	function generateLargeArray(size) {
	return Array.from({ length: size }, (_, index) => index);
	}
	describe('initial function performance', () => {
	const largeArray = generateLargeArray(1000000); // 1 million elements
	bench('es-toolkit/initial', () => {
	esToolkitInitial(largeArray);
	});
	bench('lodash/initial', () => {
	lodashInitial(largeArray);
	});
	});
	import { bench, describe } from 'vitest';
	import { initial as initialLodash } from 'lodash';
	import { initial as initialToolkit } from 'es-toolkit'; // hypothetical library
	// Helper function to generate a large array
	function generateLargeArray(size) {
	return Array.from({ length: size }, (_, index) => index);
	}
	describe('initial function performance', () => {
	const largeArray = generateLargeArray(1000000); // 1 million elements
	bench('es-toolkit/initial', () => {
	initialToolkit(largeArray);
	});
	bench('lodash/initial', () => {
	initialLodash(largeArray);
	});
	});

I think it's better for us to follow other benchmarks.

[raon0211]

Suggested change

	- `arr`(`T[]`): 마지막 요소를 제외한 나머지 요소들로 구성된 새로운 배열을 반환할 배열.
	- `arr`(`T[]`): 마지막 요소를 제외할 배열.

I guess it's better for us to simplify this description.

[raon0211]

Looks great. Thanks!