Merge pull request #272 from umsungjun/once-add-bechmark

feat: add benchmark and JSDoc for once function

Author: yceffort-naver

src/once.bench.ts

@@ -0,0 +1,23 @@
+import _once from 'lodash/once'
+import {bench, describe} from 'vitest'
+
+import once from './once'
+
+const testCase = () => 'result'
+
+const ITERATIONS = 1000
+
+describe('once performance', () => {
+    bench('hidash', () => {
+        const hidashOnce = once(testCase)
+        for (let i = 0; i < ITERATIONS; i++) {
+            hidashOnce()
+        }
+    })
+    bench('lodash', () => {
+        const lodashOnce = _once(testCase)
+        for (let i = 0; i < ITERATIONS; i++) {
+            lodashOnce()
+        }
+    })
+})

src/once.ts

@@ -1,5 +1,23 @@
 import {before} from './before'
 
+/**
+ * Creates a function that is invoked only once.
+ * Subsequent calls to the new function return the result of the first invocation.
+ * Internally uses `before(2, func)` to allow the original function to be called only once.
+ *
+ * @template T - The type of the function to restrict.
+ * @param {T} func - The function to invoke once.
+ * @returns {(...args: Parameters<T>) => ReturnType<T>} A new function that calls `func` at most once.
+ *
+ * @example
+ * const initialize = once(() => {
+ *   console.log('Initialized!');
+ *   return 'result';
+ * });
+ *
+ * initialize(); // Logs: 'Initialized!' and returns 'result'
+ * initialize(); // Returns 'result' without logging
+ */
 export function once<T extends (...args: Parameters<T>) => ReturnType<T>>(
     func: T,
 ): (...args: Parameters<T>) => ReturnType<T> {