PHP's is_scalar in TypeScript

How to use

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

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

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	is_scalar(186.31)	true
2	is_scalar({0: 'Kevin van Zonneveld'})	false

Dependencies

This function uses the following Locutus functions:

• _phpTypes (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { isPhpScalar, type PhpRuntimeValue, type PhpScalar } from '../_helpers/_phpTypes.ts'

type ScalarCheckValue = PhpRuntimeValue

export function is_scalar(mixedVar: ScalarCheckValue): mixedVar is PhpScalar {
  //  discuss at: https://locutus.io/php/is_scalar/
  // original by: Paulo Freitas
  //   example 1: is_scalar(186.31)
  //   returns 1: true
  //   example 2: is_scalar({0: 'Kevin van Zonneveld'})
  //   returns 2: false

  return isPhpScalar(mixedVar)
}

import { isPhpScalar } from '../_helpers/_phpTypes.ts'

export function is_scalar(mixedVar) {
  //  discuss at: https://locutus.io/php/is_scalar/
  // original by: Paulo Freitas
  //   example 1: is_scalar(186.31)
  //   returns 1: true
  //   example 2: is_scalar({0: 'Kevin van Zonneveld'})
  //   returns 2: false

  return isPhpScalar(mixedVar)
}

// php/_helpers/_phpTypes (Locutus helper dependency)
type PhpNullish = null | undefined

type PhpInput = {} | PhpNullish

type PhpScalar = string | number | boolean

type PhpPrimitive = PhpScalar | bigint

type PhpFunctionValue = (...args: PhpInput[]) => PhpInput

interface PhpRuntimeAssoc {
  [key: string]: PhpRuntimeValue
}

interface PhpRuntimeList extends Array<PhpRuntimeValue> {}

type PhpRuntimeValue = PhpPrimitive | PhpNullish | PhpRuntimeList | PhpRuntimeAssoc | PhpFunctionValue

function isPhpScalar(value: PhpInput): value is PhpScalar {
  return typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean'
}

// php/var/is_scalar (target function module)
type ScalarCheckValue = PhpRuntimeValue

function is_scalar(mixedVar: ScalarCheckValue): mixedVar is PhpScalar {
  //  discuss at: https://locutus.io/php/is_scalar/
  // original by: Paulo Freitas
  //   example 1: is_scalar(186.31)
  //   returns 1: true
  //   example 2: is_scalar({0: 'Kevin van Zonneveld'})
  //   returns 2: false

  return isPhpScalar(mixedVar)
}

// php/_helpers/_phpTypes (Locutus helper dependency)
function isPhpScalar(value) {
  return typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean'
}

// php/var/is_scalar (target function module)
function is_scalar(mixedVar) {
  //  discuss at: https://locutus.io/php/is_scalar/
  // original by: Paulo Freitas
  //   example 1: is_scalar(186.31)
  //   returns 1: true
  //   example 2: is_scalar({0: 'Kevin van Zonneveld'})
  //   returns 2: false

  return isPhpScalar(mixedVar)
}

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