PHP's json_decode in TypeScript

How to use

Install via yarn add locutus and import: import { json_decode } from 'locutus/php/json/json_decode'.

Or with CommonJS: const { json_decode } = require('locutus/php/json/json_decode')

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	json_decode('[ 1 ]')	[1]

Notes

• Uses the host JSON.parse implementation required by Locutus’ runtime target.

Dependencies

This function uses the following Locutus functions:

• _phpRuntimeState (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

import { setPhpRuntimeEntry } from '../_helpers/_phpRuntimeState.ts'

type JsonPrimitive = string | number | boolean | null
type JsonValue = JsonPrimitive | JsonValue[] | { [key: string]: JsonValue }

export function json_decode<T = JsonValue>(strJson: string): T | null {
  //       discuss at: https://phpjs.org/functions/json_decode/
  //  parity verified: PHP 8.3
  //      original by: Public Domain (https://www.json.org/json2.js)
  // reimplemented by: Kevin van Zonneveld (https://kevin.vanzonneveld.net)
  //      improved by: T.J. Leahy
  //      improved by: Michael White
  //           note 1: Uses the host JSON.parse implementation required by Locutus' runtime target.
  //        example 1: json_decode('[ 1 ]')
  //        returns 1: [1]

  const json = typeof JSON === 'object' && JSON !== null ? JSON : null
  const parse = json?.parse
  if (typeof parse !== 'function') {
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }

  try {
    const parsed = parse.call(json, strJson)
    setPhpRuntimeEntry('last_error_json', 0)
    return parsed
  } catch (err) {
    if (!(err instanceof SyntaxError)) {
      throw new Error('Unexpected error type in json_decode()')
    }

    // usable by json_last_error()
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }
}

import { setPhpRuntimeEntry } from '../_helpers/_phpRuntimeState.ts'

export function json_decode(strJson) {
  //       discuss at: https://phpjs.org/functions/json_decode/
  //  parity verified: PHP 8.3
  //      original by: Public Domain (https://www.json.org/json2.js)
  // reimplemented by: Kevin van Zonneveld (https://kevin.vanzonneveld.net)
  //      improved by: T.J. Leahy
  //      improved by: Michael White
  //           note 1: Uses the host JSON.parse implementation required by Locutus' runtime target.
  //        example 1: json_decode('[ 1 ]')
  //        returns 1: [1]

  const json = typeof JSON === 'object' && JSON !== null ? JSON : null
  const parse = json?.parse
  if (typeof parse !== 'function') {
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }

  try {
    const parsed = parse.call(json, strJson)
    setPhpRuntimeEntry('last_error_json', 0)
    return parsed
  } catch (err) {
    if (!(err instanceof SyntaxError)) {
      throw new Error('Unexpected error type in json_decode()')
    }

    // usable by json_last_error()
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }
}

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

type PhpInput = {} | PhpNullish

type PhpList<T = PhpInput> = T[]

type PhpAssoc<T = PhpInput> = { [key: string]: T }

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
interface IniEntry {
  local_value?: PhpInput
}

type LocaleEntry = PhpAssoc<PhpInput> & {
  sorting?: (left: PhpInput, right: PhpInput) => number
}

type LocaleCategoryMap = PhpAssoc<string | undefined>

interface LocutusRuntimeContainer {
  php?: PhpAssoc<PhpInput>
}

interface PhpRuntimeKnownEntryMap {
  ini: PhpAssoc<IniEntry | undefined>
  locales: PhpAssoc<LocaleEntry | undefined>
  localeCategories: LocaleCategoryMap
  pointers: PhpList<PhpInput>
  locale_default: string
  locale: string
  uniqidSeed: number
  timeoutStatus: boolean
  last_error_json: number
  strtokleftOver: string
}

type GlobalWithLocutus = {
  $locutus?: LocutusRuntimeContainer
  [key: string]: PhpInput
}

const globalContext: GlobalWithLocutus =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = (): PhpAssoc<PhpInput> => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function setPhpRuntimeEntry<TKey extends keyof PhpRuntimeKnownEntryMap>(
  key: TKey,
  value: PhpRuntimeKnownEntryMap[TKey],
): void

function setPhpRuntimeEntry(key: string, value: PhpInput): void

function setPhpRuntimeEntry(key: string, value: PhpInput): void {
  const php = ensurePhpRuntimeObject()
  php[key] = value
}

// php/json/json_decode (target function module)
type JsonPrimitive = string | number | boolean | null

type JsonValue = JsonPrimitive | JsonValue[] | { [key: string]: JsonValue }

function json_decode<T = JsonValue>(strJson: string): T | null {
  //       discuss at: https://phpjs.org/functions/json_decode/
  //  parity verified: PHP 8.3
  //      original by: Public Domain (https://www.json.org/json2.js)
  // reimplemented by: Kevin van Zonneveld (https://kevin.vanzonneveld.net)
  //      improved by: T.J. Leahy
  //      improved by: Michael White
  //           note 1: Uses the host JSON.parse implementation required by Locutus' runtime target.
  //        example 1: json_decode('[ 1 ]')
  //        returns 1: [1]

  const json = typeof JSON === 'object' && JSON !== null ? JSON : null
  const parse = json?.parse
  if (typeof parse !== 'function') {
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }

  try {
    const parsed = parse.call(json, strJson)
    setPhpRuntimeEntry('last_error_json', 0)
    return parsed
  } catch (err) {
    if (!(err instanceof SyntaxError)) {
      throw new Error('Unexpected error type in json_decode()')
    }

    // usable by json_last_error()
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }
}

// php/_helpers/_phpRuntimeState (Locutus helper dependency)
const globalContext =
  typeof window === 'object' && window !== null ? window : typeof global === 'object' && global !== null ? global : {}

const ensurePhpRuntimeObject = () => {
  let locutus = globalContext.$locutus
  if (typeof locutus !== 'object' || locutus === null) {
    locutus = {}
    globalContext.$locutus = locutus
  }

  let php = locutus.php
  if (typeof php !== 'object' || php === null) {
    php = {}
    locutus.php = php
  }

  return php
}

function setPhpRuntimeEntry(key, value) {
  const php = ensurePhpRuntimeObject()
  php[key] = value
}

// php/json/json_decode (target function module)
function json_decode(strJson) {
  //       discuss at: https://phpjs.org/functions/json_decode/
  //  parity verified: PHP 8.3
  //      original by: Public Domain (https://www.json.org/json2.js)
  // reimplemented by: Kevin van Zonneveld (https://kevin.vanzonneveld.net)
  //      improved by: T.J. Leahy
  //      improved by: Michael White
  //           note 1: Uses the host JSON.parse implementation required by Locutus' runtime target.
  //        example 1: json_decode('[ 1 ]')
  //        returns 1: [1]

  const json = typeof JSON === 'object' && JSON !== null ? JSON : null
  const parse = json?.parse
  if (typeof parse !== 'function') {
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }

  try {
    const parsed = parse.call(json, strJson)
    setPhpRuntimeEntry('last_error_json', 0)
    return parsed
  } catch (err) {
    if (!(err instanceof SyntaxError)) {
      throw new Error('Unexpected error type in json_decode()')
    }

    // usable by json_last_error()
    setPhpRuntimeEntry('last_error_json', 4)
    return null
  }
}

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 json functions

Star