PHP's floatval in TypeScript

How to use

Install via yarn add locutus and import: import { floatval } from 'locutus/php/var/floatval'.

Or with CommonJS: const { floatval } = require('locutus/php/var/floatval')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	floatval('150.03_page-section')	150.03
2	floatval('page: 3') floatval('-50 + 8')	0 -50

Notes

• The native parseFloat() method of JavaScript returns NaN when it encounters a string before an int or float value.

Here's what our current TypeScript equivalent to PHP's floatval looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import type { NumericLike, PhpNullish } from '../_helpers/_phpTypes.ts'

export type FloatvalInput = NumericLike | boolean | PhpNullish

export function floatval(mixedVar: FloatvalInput): number {
  //      discuss at: https://locutus.io/php/floatval/
  // parity verified: PHP 8.3
  //     original by: Michael White (https://getsprink.com)
  //          note 1: The native parseFloat() method of JavaScript returns NaN
  //          note 1: when it encounters a string before an int or float value.
  //       example 1: floatval('150.03_page-section')
  //       returns 1: 150.03
  //       example 2: floatval('page: 3')
  //       example 2: floatval('-50 + 8')
  //       returns 2: 0
  //       returns 2: -50

  return parseFloat(String(mixedVar ?? '')) || 0
}

export function floatval(mixedVar) {
  //      discuss at: https://locutus.io/php/floatval/
  // parity verified: PHP 8.3
  //     original by: Michael White (https://getsprink.com)
  //          note 1: The native parseFloat() method of JavaScript returns NaN
  //          note 1: when it encounters a string before an int or float value.
  //       example 1: floatval('150.03_page-section')
  //       returns 1: 150.03
  //       example 2: floatval('page: 3')
  //       example 2: floatval('-50 + 8')
  //       returns 2: 0
  //       returns 2: -50

  return parseFloat(String(mixedVar ?? '')) || 0
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

« More PHP var functions

Star