PHP's array_merge_recursive in TypeScript

How to use

Install via yarn add locutus and import: import { array_merge_recursive } from 'locutus/php/array/array_merge_recursive'.

Or with CommonJS: const { array_merge_recursive } = require('locutus/php/array/array_merge_recursive')

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	var $arr1 = {'color': {'favorite': 'red'}, 0: 5} var $arr2 = {0: 10, 'color': {'favorite': 'green', 0: 'blue'}} array_merge_recursive($arr1, $arr2)	{'color': {'favorite': ['red', 'green'], 0: 'blue'}, 0: 5, 1: 10}

PHP arrays and TypeScript/JavaScript

Please note that Locutus uses TypeScript/JavaScript objects as substitutes for PHP arrays, they are the closest we can get to this hashtable-like data structure without rolling our own. While many TypeScript/JavaScript implementations preserve the order of object properties, the ECMAScript Language Specification explicitly states that:

The mechanics and order of enumerating the properties is not specified.

In practice most engines preserve insertion order, but if your code depends on key ordering across platforms, keep this caveat in mind.

To influence how Locutus treats objects as arrays, you can check out the locutus.objectsAsArrays setting.

Notes

• Numeric keys are renumbered starting from 0, string keys are preserved

Dependencies

This function uses the following Locutus functions:

• _phpTypes (php/_helpers)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

interface MergeObject extends PhpAssoc<MergeValue> {}
type MergeValue = PhpRuntimeValue | MergeValue[] | MergeObject

function mergeInto(result: MergeObject, source: MergeObject): void {
  let numericIdx = Object.keys(result).filter((key) => parseInt(key, 10) + '' === key + '').length

  // Helper to check if a key is numeric (PHP integer-indexed)
  const isNumericKey = function (key: string): boolean {
    return parseInt(key, 10) + '' === key + ''
  }

  // Helper to check if value is a plain object (not array)
  const isPlainObject = function (val: PhpRuntimeValue): val is MergeObject {
    return isObjectLike(val) && !Array.isArray(val)
  }

  for (const [key, sourceValue] of Object.entries(source)) {
    if (isNumericKey(key)) {
      result[numericIdx++] = sourceValue
    } else if (key in result) {
      const resultValue = result[key]
      if (isPlainObject(resultValue) && isPlainObject(sourceValue)) {
        result[key] = array_merge_recursive(resultValue, sourceValue)
      } else if (Array.isArray(resultValue)) {
        resultValue.push(sourceValue)
      } else {
        result[key] = [resultValue, sourceValue]
      }
    } else {
      result[key] = sourceValue
    }
  }
}

export function array_merge_recursive(...arrays: MergeObject[]): MergeObject {
  //       discuss at: https://locutus.io/php/array_merge_recursive/
  //      original by: Subhasis Deb
  //         input by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Kevin van Zonneveld (https://kvz.io)
  // reimplemented by: Kevin van Zonneveld (https://kvz.io)
  //           note 1: Numeric keys are renumbered starting from 0, string keys are preserved
  //        example 1: var $arr1 = {'color': {'favorite': 'red'}, 0: 5}
  //        example 1: var $arr2 = {0: 10, 'color': {'favorite': 'green', 0: 'blue'}}
  //        example 1: array_merge_recursive($arr1, $arr2)
  //        returns 1: {'color': {'favorite': ['red', 'green'], 0: 'blue'}, 0: 5, 1: 10}

  if (arrays.length === 0) {
    return {}
  }

  const result: MergeObject = {}
  for (const array of arrays) {
    mergeInto(result, array)
  }

  return result
}

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

function mergeInto(result, source) {
  let numericIdx = Object.keys(result).filter((key) => parseInt(key, 10) + '' === key + '').length

  // Helper to check if a key is numeric (PHP integer-indexed)
  const isNumericKey = function (key) {
    return parseInt(key, 10) + '' === key + ''
  }

  // Helper to check if value is a plain object (not array)
  const isPlainObject = function (val) {
    return isObjectLike(val) && !Array.isArray(val)
  }

  for (const [key, sourceValue] of Object.entries(source)) {
    if (isNumericKey(key)) {
      result[numericIdx++] = sourceValue
    } else if (key in result) {
      const resultValue = result[key]
      if (isPlainObject(resultValue) && isPlainObject(sourceValue)) {
        result[key] = array_merge_recursive(resultValue, sourceValue)
      } else if (Array.isArray(resultValue)) {
        resultValue.push(sourceValue)
      } else {
        result[key] = [resultValue, sourceValue]
      }
    } else {
      result[key] = sourceValue
    }
  }
}

export function array_merge_recursive(...arrays) {
  //       discuss at: https://locutus.io/php/array_merge_recursive/
  //      original by: Subhasis Deb
  //         input by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Kevin van Zonneveld (https://kvz.io)
  // reimplemented by: Kevin van Zonneveld (https://kvz.io)
  //           note 1: Numeric keys are renumbered starting from 0, string keys are preserved
  //        example 1: var $arr1 = {'color': {'favorite': 'red'}, 0: 5}
  //        example 1: var $arr2 = {0: 10, 'color': {'favorite': 'green', 0: 'blue'}}
  //        example 1: array_merge_recursive($arr1, $arr2)
  //        returns 1: {'color': {'favorite': ['red', 'green'], 0: 'blue'}, 0: 5, 1: 10}

  if (arrays.length === 0) {
    return {}
  }

  const result = {}
  for (const array of arrays) {
    mergeInto(result, array)
  }

  return result
}

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

type PhpInput = {} | PhpNullish

type PhpScalar = string | number | boolean

type PhpPrimitive = PhpScalar | bigint

type PhpList<T = PhpInput> = T[]

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

type PhpArrayLike<T = PhpInput> = PhpList<T> | PhpAssoc<T>

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

interface PhpRuntimeAssoc {
  [key: string]: PhpRuntimeValue
}

interface PhpRuntimeList extends Array<PhpRuntimeValue> {}

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

function isObjectLike(value: PhpInput): value is PhpArrayLike<PhpInput> {
  return typeof value === 'object' && value !== null
}

// php/array/array_merge_recursive (target function module)
interface MergeObject extends PhpAssoc<MergeValue> {}

type MergeValue = PhpRuntimeValue | MergeValue[] | MergeObject

function mergeInto(result: MergeObject, source: MergeObject): void {
  let numericIdx = Object.keys(result).filter((key) => parseInt(key, 10) + '' === key + '').length

  // Helper to check if a key is numeric (PHP integer-indexed)
  const isNumericKey = function (key: string): boolean {
    return parseInt(key, 10) + '' === key + ''
  }

  // Helper to check if value is a plain object (not array)
  const isPlainObject = function (val: PhpRuntimeValue): val is MergeObject {
    return isObjectLike(val) && !Array.isArray(val)
  }

  for (const [key, sourceValue] of Object.entries(source)) {
    if (isNumericKey(key)) {
      result[numericIdx++] = sourceValue
    } else if (key in result) {
      const resultValue = result[key]
      if (isPlainObject(resultValue) && isPlainObject(sourceValue)) {
        result[key] = array_merge_recursive(resultValue, sourceValue)
      } else if (Array.isArray(resultValue)) {
        resultValue.push(sourceValue)
      } else {
        result[key] = [resultValue, sourceValue]
      }
    } else {
      result[key] = sourceValue
    }
  }
}

function array_merge_recursive(...arrays: MergeObject[]): MergeObject {
  //       discuss at: https://locutus.io/php/array_merge_recursive/
  //      original by: Subhasis Deb
  //         input by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Kevin van Zonneveld (https://kvz.io)
  // reimplemented by: Kevin van Zonneveld (https://kvz.io)
  //           note 1: Numeric keys are renumbered starting from 0, string keys are preserved
  //        example 1: var $arr1 = {'color': {'favorite': 'red'}, 0: 5}
  //        example 1: var $arr2 = {0: 10, 'color': {'favorite': 'green', 0: 'blue'}}
  //        example 1: array_merge_recursive($arr1, $arr2)
  //        returns 1: {'color': {'favorite': ['red', 'green'], 0: 'blue'}, 0: 5, 1: 10}

  if (arrays.length === 0) {
    return {}
  }

  const result: MergeObject = {}
  for (const array of arrays) {
    mergeInto(result, array)
  }

  return result
}

// php/_helpers/_phpTypes (Locutus helper dependency)
function isObjectLike(value) {
  return typeof value === 'object' && value !== null
}

// php/array/array_merge_recursive (target function module)
function mergeInto(result, source) {
  let numericIdx = Object.keys(result).filter((key) => parseInt(key, 10) + '' === key + '').length

  // Helper to check if a key is numeric (PHP integer-indexed)
  const isNumericKey = function (key) {
    return parseInt(key, 10) + '' === key + ''
  }

  // Helper to check if value is a plain object (not array)
  const isPlainObject = function (val) {
    return isObjectLike(val) && !Array.isArray(val)
  }

  for (const [key, sourceValue] of Object.entries(source)) {
    if (isNumericKey(key)) {
      result[numericIdx++] = sourceValue
    } else if (key in result) {
      const resultValue = result[key]
      if (isPlainObject(resultValue) && isPlainObject(sourceValue)) {
        result[key] = array_merge_recursive(resultValue, sourceValue)
      } else if (Array.isArray(resultValue)) {
        resultValue.push(sourceValue)
      } else {
        result[key] = [resultValue, sourceValue]
      }
    } else {
      result[key] = sourceValue
    }
  }
}

function array_merge_recursive(...arrays) {
  //       discuss at: https://locutus.io/php/array_merge_recursive/
  //      original by: Subhasis Deb
  //         input by: Brett Zamir (https://brett-zamir.me)
  //      bugfixed by: Kevin van Zonneveld (https://kvz.io)
  // reimplemented by: Kevin van Zonneveld (https://kvz.io)
  //           note 1: Numeric keys are renumbered starting from 0, string keys are preserved
  //        example 1: var $arr1 = {'color': {'favorite': 'red'}, 0: 5}
  //        example 1: var $arr2 = {0: 10, 'color': {'favorite': 'green', 0: 'blue'}}
  //        example 1: array_merge_recursive($arr1, $arr2)
  //        returns 1: {'color': {'favorite': ['red', 'green'], 0: 'blue'}, 0: 5, 1: 10}

  if (arrays.length === 0) {
    return {}
  }

  const result = {}
  for (const array of arrays) {
    mergeInto(result, array)
  }

  return result
}

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

Star