es-toolkit 1.27.0 → 1.28.0-dev.908

package/dist/function/throttle.d.ts

@@ -12,6 +12,11 @@ interface ThrottleOptions {
      */
     edges?: Array<'leading' | 'trailing'>;
 }
+interface ThrottledFunction<F extends (...args: any[]) => void> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+    flush: () => void;
+}
 /**
  * Creates a throttled function that only invokes the provided function at most once
  * per every `throttleMs` milliseconds. Subsequent calls to the throttled function
@@ -38,9 +43,6 @@ interface ThrottleOptions {
  *   throttledFunction(); // Will log 'Function executed'
  * }, 1000);
  */
-declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ((...args: Parameters<F>) => void) & {
-    cancel: () => void;
-    flush: () => void;
-};
+declare function throttle<F extends (...args: any[]) => void>(func: F, throttleMs: number, { signal, edges }?: ThrottleOptions): ThrottledFunction<F>;
 
-export { throttle };
+export { type ThrottledFunction, throttle };

package/dist/index.d.mts

@@ -62,7 +62,7 @@ export { ary } from './function/ary.mjs';
 export { before } from './function/before.mjs';
 export { curry } from './function/curry.mjs';
 export { curryRight } from './function/curryRight.mjs';
-export { debounce } from './function/debounce.mjs';
+export { DebouncedFunction, debounce } from './function/debounce.mjs';
 export { flow } from './function/flow.mjs';
 export { flowRight } from './function/flowRight.mjs';
 export { identity } from './function/identity.mjs';
@@ -74,7 +74,7 @@ export { partial } from './function/partial.mjs';
 export { partialRight } from './function/partialRight.mjs';
 export { rest } from './function/rest.mjs';
 export { spread } from './function/spread.mjs';
-export { throttle } from './function/throttle.mjs';
+export { ThrottledFunction, throttle } from './function/throttle.mjs';
 export { unary } from './function/unary.mjs';
 export { clamp } from './math/clamp.mjs';
 export { inRange } from './math/inRange.mjs';
@@ -106,6 +106,7 @@ export { toMerged } from './object/toMerged.mjs';
 export { isArrayBuffer } from './predicate/isArrayBuffer.mjs';
 export { isBlob } from './predicate/isBlob.mjs';
 export { isBoolean } from './predicate/isBoolean.mjs';
+export { isBuffer } from './predicate/isBuffer.mjs';
 export { isDate } from './predicate/isDate.mjs';
 export { isEqual } from './predicate/isEqual.mjs';
 export { isEqualWith } from './predicate/isEqualWith.mjs';

package/dist/index.d.ts

@@ -62,7 +62,7 @@ export { ary } from './function/ary.js';
 export { before } from './function/before.js';
 export { curry } from './function/curry.js';
 export { curryRight } from './function/curryRight.js';
-export { debounce } from './function/debounce.js';
+export { DebouncedFunction, debounce } from './function/debounce.js';
 export { flow } from './function/flow.js';
 export { flowRight } from './function/flowRight.js';
 export { identity } from './function/identity.js';
@@ -74,7 +74,7 @@ export { partial } from './function/partial.js';
 export { partialRight } from './function/partialRight.js';
 export { rest } from './function/rest.js';
 export { spread } from './function/spread.js';
-export { throttle } from './function/throttle.js';
+export { ThrottledFunction, throttle } from './function/throttle.js';
 export { unary } from './function/unary.js';
 export { clamp } from './math/clamp.js';
 export { inRange } from './math/inRange.js';
@@ -106,6 +106,7 @@ export { toMerged } from './object/toMerged.js';
 export { isArrayBuffer } from './predicate/isArrayBuffer.js';
 export { isBlob } from './predicate/isBlob.js';
 export { isBoolean } from './predicate/isBoolean.js';
+export { isBuffer } from './predicate/isBuffer.js';
 export { isDate } from './predicate/isDate.js';
 export { isEqual } from './predicate/isEqual.js';
 export { isEqualWith } from './predicate/isEqualWith.js';

package/dist/index.js

@@ -13,10 +13,10 @@ const randomInt = require('./_chunk/randomInt-CF7bZK.js');
 const math_index = require('./math/index.js');
 const toMerged = require('./_chunk/toMerged-CPY8Ug.js');
 const object_index = require('./object/index.js');
-const isWeakSet = require('./_chunk/isWeakSet-D8h8bS.js');
+const isWeakSet = require('./_chunk/isWeakSet-CvIdTA.js');
 const predicate_index = require('./predicate/index.js');
 const isPlainObject = require('./_chunk/isPlainObject-octpoD.js');
-const upperFirst = require('./_chunk/upperFirst-DK_rTF.js');
+const upperFirst = require('./_chunk/upperFirst-CorAVn.js');
 const string_index = require('./string/index.js');
 const util_index = require('./util/index.js');
 
@@ -132,6 +132,7 @@ exports.omit = object_index.omit;
 exports.pick = object_index.pick;
 exports.isArrayBuffer = isWeakSet.isArrayBuffer;
 exports.isBlob = isWeakSet.isBlob;
+exports.isBuffer = isWeakSet.isBuffer;
 exports.isDate = isWeakSet.isDate;
 exports.isEqual = isWeakSet.isEqual;
 exports.isEqualWith = isWeakSet.isEqualWith;

package/dist/index.mjs

@@ -106,6 +106,7 @@ export { toMerged } from './object/toMerged.mjs';
 export { isArrayBuffer } from './predicate/isArrayBuffer.mjs';
 export { isBlob } from './predicate/isBlob.mjs';
 export { isBoolean } from './predicate/isBoolean.mjs';
+export { isBuffer } from './predicate/isBuffer.mjs';
 export { isDate } from './predicate/isDate.mjs';
 export { isEqual } from './predicate/isEqual.mjs';
 export { isEqualWith } from './predicate/isEqualWith.mjs';

package/dist/predicate/index.d.mts

@@ -1,6 +1,7 @@
 export { isArrayBuffer } from './isArrayBuffer.mjs';
 export { isBlob } from './isBlob.mjs';
 export { isBoolean } from './isBoolean.mjs';
+export { isBuffer } from './isBuffer.mjs';
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
 export { isEqualWith } from './isEqualWith.mjs';

package/dist/predicate/index.d.ts

@@ -1,6 +1,7 @@
 export { isArrayBuffer } from './isArrayBuffer.js';
 export { isBlob } from './isBlob.js';
 export { isBoolean } from './isBoolean.js';
+export { isBuffer } from './isBuffer.js';
 export { isDate } from './isDate.js';
 export { isEqual } from './isEqual.js';
 export { isEqualWith } from './isEqualWith.js';

package/dist/predicate/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const isWeakSet = require('../_chunk/isWeakSet-D8h8bS.js');
+const isWeakSet = require('../_chunk/isWeakSet-CvIdTA.js');
 const isPlainObject = require('../_chunk/isPlainObject-octpoD.js');
 
 function isBoolean(x) {
@@ -23,6 +23,7 @@ function isSymbol(value) {
 
 exports.isArrayBuffer = isWeakSet.isArrayBuffer;
 exports.isBlob = isWeakSet.isBlob;
+exports.isBuffer = isWeakSet.isBuffer;
 exports.isDate = isWeakSet.isDate;
 exports.isEqual = isWeakSet.isEqual;
 exports.isEqualWith = isWeakSet.isEqualWith;

package/dist/predicate/index.mjs

@@ -1,6 +1,7 @@
 export { isArrayBuffer } from './isArrayBuffer.mjs';
 export { isBlob } from './isBlob.mjs';
 export { isBoolean } from './isBoolean.mjs';
+export { isBuffer } from './isBuffer.mjs';
 export { isDate } from './isDate.mjs';
 export { isEqual } from './isEqual.mjs';
 export { isEqualWith } from './isEqualWith.mjs';

package/dist/predicate/isBuffer.d.mts

@@ -0,0 +1,21 @@
+/**
+ * Checks if the given value is a Buffer instance.
+ *
+ * This function tests whether the provided value is an instance of Buffer.
+ * It returns `true` if the value is a Buffer, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Buffer`.
+ *
+ * @param {unknown} x - The value to check if it is a Buffer.
+ * @returns {boolean} Returns `true` if `x` is a Buffer, else `false`.
+ *
+ * @example
+ * const buffer = Buffer.from("test");
+ * console.log(isBuffer(buffer)); // true
+ *
+ * const notBuffer = "not a buffer";
+ * console.log(isBuffer(notBuffer)); // false
+ */
+declare function isBuffer(x: unknown): boolean;
+
+export { isBuffer };

package/dist/predicate/isBuffer.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Checks if the given value is a Buffer instance.
+ *
+ * This function tests whether the provided value is an instance of Buffer.
+ * It returns `true` if the value is a Buffer, and `false` otherwise.
+ *
+ * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `Buffer`.
+ *
+ * @param {unknown} x - The value to check if it is a Buffer.
+ * @returns {boolean} Returns `true` if `x` is a Buffer, else `false`.
+ *
+ * @example
+ * const buffer = Buffer.from("test");
+ * console.log(isBuffer(buffer)); // true
+ *
+ * const notBuffer = "not a buffer";
+ * console.log(isBuffer(notBuffer)); // false
+ */
+declare function isBuffer(x: unknown): boolean;
+
+export { isBuffer };

package/dist/predicate/isBuffer.mjs

@@ -0,0 +1,5 @@
+function isBuffer(x) {
+    return typeof Buffer !== 'undefined' && Buffer.isBuffer(x);
+}
+
+export { isBuffer };

package/dist/string/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-const upperFirst = require('../_chunk/upperFirst-DK_rTF.js');
+const upperFirst = require('../_chunk/upperFirst-CorAVn.js');
 
 function startCase(str) {
     const words = upperFirst.words(str.trim());

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "es-toolkit",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
-  "version": "1.27.0",
+  "version": "1.28.0-dev.908+e1c05f28",
   "homepage": "https://es-toolkit.slash.page",
   "bugs": "https://github.com/toss/es-toolkit/issues",
   "repository": {