PHP's empty in TypeScript

How to use

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

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

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	empty(null)	true
2	empty(undefined)	true
3	empty([])	true
4	empty({})	true
5	empty({'aFunc' : function () { alert('humpty'); } })	false

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

type EmptyValue = PhpRuntimeValue

export function empty(mixedVar: EmptyValue): boolean {
  //  discuss at: https://locutus.io/php/empty/
  // original by: Philippe Baumann
  //    input by: Onno Marsman (https://twitter.com/onnomarsman)
  //    input by: LH
  //    input by: Stoyan Kyosev (https://www.svest.org/)
  // bugfixed by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Onno Marsman (https://twitter.com/onnomarsman)
  // improved by: Francesco
  // improved by: Marc Jansen
  // improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //   example 1: empty(null)
  //   returns 1: true
  //   example 2: empty(undefined)
  //   returns 2: true
  //   example 3: empty([])
  //   returns 3: true
  //   example 4: empty({})
  //   returns 4: true
  //   example 5: empty({'aFunc' : function () { alert('humpty'); } })
  //   returns 5: false

  const emptyValues: EmptyValue[] = [undefined, null, false, 0, '', '0']

  for (const emptyValue of emptyValues) {
    if (mixedVar === emptyValue) {
      return true
    }
  }

  if (typeof mixedVar === 'object' && mixedVar !== null) {
    return Object.keys(mixedVar).length === 0
  }

  return false
}

export function empty(mixedVar) {
  //  discuss at: https://locutus.io/php/empty/
  // original by: Philippe Baumann
  //    input by: Onno Marsman (https://twitter.com/onnomarsman)
  //    input by: LH
  //    input by: Stoyan Kyosev (https://www.svest.org/)
  // bugfixed by: Kevin van Zonneveld (https://kvz.io)
  // improved by: Onno Marsman (https://twitter.com/onnomarsman)
  // improved by: Francesco
  // improved by: Marc Jansen
  // improved by: Rafał Kukawski (https://blog.kukawski.pl)
  //   example 1: empty(null)
  //   returns 1: true
  //   example 2: empty(undefined)
  //   returns 2: true
  //   example 3: empty([])
  //   returns 3: true
  //   example 4: empty({})
  //   returns 4: true
  //   example 5: empty({'aFunc' : function () { alert('humpty'); } })
  //   returns 5: false

  const emptyValues = [undefined, null, false, 0, '', '0']

  for (const emptyValue of emptyValues) {
    if (mixedVar === emptyValue) {
      return true
    }
  }

  if (typeof mixedVar === 'object' && mixedVar !== null) {
    return Object.keys(mixedVar).length === 0
  }

  return false
}

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