toInteger()

toInteger(value): number

Converts value to an integer.

DEPRECATED

Use Math.trunc(Number()) directly instead.

---

Parameters

value: unknown

The value to convert.

---

Returns: number

The converted integer.

---

See Also

• Math.trunc() - MDN
• Browser support - Can I Use

---

Since

2.0.0

---

Also known as

toInteger (Lodash, es-toolkit) · ❌ (Remeda, Radashi, Ramda, Effect, Modern Dash, Antfu)

---

Example

// ❌ Deprecated approach
toInteger(3.7);      // => 3
toInteger(-3.7);     // => -3
toInteger('3.7');    // => 3
toInteger(Infinity); // => Infinity

// ✅ Recommended approach
Math.trunc(3.7);         // => 3
Math.trunc(-3.7);        // => -3
Math.trunc(Number('3.7')); // => 3

---

How it works?

Converts value to an integer. Deprecated: Use Math.trunc() or bitwise | 0.

Native Equivalent

// ❌ toInteger(value)
// ✅ Math.trunc(Number(value))
// ✅ value | 0  // for 32-bit integers

---

Use Cases

Convert to integer 📌

Convert value to integer by truncating decimals.

#integer#convert#truncate#number

Math.trunc(3.7);   // 3
Math.trunc(-3.7);  // -3

Parse user input

Convert string input to integer.

#parse#input#integer#form

const quantity = Math.trunc(Number(input));

Index calculation

Ensure array index is integer.

#index#array#calculation

const index = Math.trunc(position * items.length);
const item = items[index];