PHP's join in TypeScript

How to use

Install via yarn add locutus and import: import { join } from 'locutus/php/strings/join'.

Or with CommonJS: const { join } = require('locutus/php/strings/join')

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	join(' ', ['Kevin', 'van', 'Zonneveld'])	'Kevin van Zonneveld'

Dependencies

This function uses the following Locutus functions:

• implode (php/strings)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

type JoinValue = PhpRuntimeValue

export function join(glue: string, pieces: JoinValue[]): string {
  //      discuss at: https://locutus.io/php/join/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: join(' ', ['Kevin', 'van', 'Zonneveld'])
  //       returns 1: 'Kevin van Zonneveld'

  return implode(glue, pieces)
}

import { implode } from '../strings/implode.ts'

export function join(glue, pieces) {
  //      discuss at: https://locutus.io/php/join/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: join(' ', ['Kevin', 'van', 'Zonneveld'])
  //       returns 1: 'Kevin van Zonneveld'

  return implode(glue, pieces)
}

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

type PhpInput = {} | PhpNullish

type PhpScalar = string | number | boolean

type PhpPrimitive = PhpScalar | bigint

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

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

interface PhpRuntimeAssoc {
  [key: string]: PhpRuntimeValue
}

interface PhpRuntimeList extends Array<PhpRuntimeValue> {}

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

// php/strings/implode (Locutus dependency module)
type ImplodeValue = PhpRuntimeValue

type KeyedValues = PhpAssoc<ImplodeValue>

function implode(pieces: ImplodeValue[] | KeyedValues | string | undefined): string

function implode(glue: string, pieces: ImplodeValue[] | KeyedValues | string | undefined): string

function implode(
  ...providedArgs: [
    glueOrPieces?: ImplodeValue[] | KeyedValues | string,
    pieces?: ImplodeValue[] | KeyedValues | string | undefined,
  ]
): string {
  //      discuss at: https://locutus.io/php/implode/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: Waldo Malqui Silva (https://waldo.malqui.info)
  //     improved by: Itsacon (https://www.itsacon.net/)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //       example 1: implode(' ', ['Kevin', 'van', 'Zonneveld'])
  //       returns 1: 'Kevin van Zonneveld'
  //       example 2: implode(' ', {first:'Kevin', last: 'van Zonneveld'})
  //       returns 2: 'Kevin van Zonneveld'

  let retVal = ''
  let tGlue = ''
  let actualGlue = ''
  let actualPieces: ImplodeValue[] | KeyedValues | string | undefined

  if (providedArgs.length === 1) {
    const [glueOrPieces] = providedArgs
    actualPieces = glueOrPieces
  } else {
    const [glueOrPieces, pieces] = providedArgs
    actualGlue = String(glueOrPieces ?? '')
    actualPieces = pieces
  }

  if (typeof actualPieces === 'object' && actualPieces !== null) {
    if (Array.isArray(actualPieces)) {
      return actualPieces.join(actualGlue)
    }
    for (const key in actualPieces) {
      retVal += tGlue + actualPieces[key]
      tGlue = actualGlue
    }
    return retVal
  }

  return String(actualPieces)
}

// php/strings/join (target function module)
type JoinValue = PhpRuntimeValue

function join(glue: string, pieces: JoinValue[]): string {
  //      discuss at: https://locutus.io/php/join/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: join(' ', ['Kevin', 'van', 'Zonneveld'])
  //       returns 1: 'Kevin van Zonneveld'

  return implode(glue, pieces)
}

// php/strings/implode (Locutus dependency module)

function implode(...providedArgs) {
  //      discuss at: https://locutus.io/php/implode/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: Waldo Malqui Silva (https://waldo.malqui.info)
  //     improved by: Itsacon (https://www.itsacon.net/)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //       example 1: implode(' ', ['Kevin', 'van', 'Zonneveld'])
  //       returns 1: 'Kevin van Zonneveld'
  //       example 2: implode(' ', {first:'Kevin', last: 'van Zonneveld'})
  //       returns 2: 'Kevin van Zonneveld'

  let retVal = ''
  let tGlue = ''
  let actualGlue = ''
  let actualPieces

  if (providedArgs.length === 1) {
    const [glueOrPieces] = providedArgs
    actualPieces = glueOrPieces
  } else {
    const [glueOrPieces, pieces] = providedArgs
    actualGlue = String(glueOrPieces ?? '')
    actualPieces = pieces
  }

  if (typeof actualPieces === 'object' && actualPieces !== null) {
    if (Array.isArray(actualPieces)) {
      return actualPieces.join(actualGlue)
    }
    for (const key in actualPieces) {
      retVal += tGlue + actualPieces[key]
      tGlue = actualGlue
    }
    return retVal
  }

  return String(actualPieces)
}

// php/strings/join (target function module)
function join(glue, pieces) {
  //      discuss at: https://locutus.io/php/join/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: join(' ', ['Kevin', 'van', 'Zonneveld'])
  //       returns 1: 'Kevin van Zonneveld'

  return implode(glue, pieces)
}

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

Star