PHP's split in TypeScript

How to use

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

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

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

Dependencies

This function uses the following Locutus functions:

• explode (php/strings)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

type SplitValue = PhpRuntimeValue
type KeyedValues = PhpAssoc<SplitValue>

export function split(
  delimiter: string | boolean | null | undefined,
  string: string | KeyedValues | (() => SplitValue) | undefined,
): string[] | false | { 0: string } | null {
  //      discuss at: https://locutus.io/php/split/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: split(' ', 'Kevin van Zonneveld')
  //       returns 1: ['Kevin', 'van', 'Zonneveld']

  return explode(delimiter, string)
}

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

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

  return explode(delimiter, string)
}

// 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/explode (Locutus dependency module)
type ExplodeValue = PhpRuntimeValue

type KeyedValues = PhpAssoc<ExplodeValue>

function explode(
  ...args: [string | boolean | null | undefined, string | KeyedValues | (() => ExplodeValue) | undefined, number?]
): string[] | false | { 0: string } | null {
  //      discuss at: https://locutus.io/php/explode/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: explode(' ', 'Kevin van Zonneveld')
  //       returns 1: [ 'Kevin', 'van', 'Zonneveld' ]

  let [delimiterRaw, stringRaw, limit] = args
  let delimiter = delimiterRaw
  const string = stringRaw

  if (args.length < 2 || typeof delimiter === 'undefined' || typeof string === 'undefined') {
    return null
  }
  if (delimiter === '' || delimiter === false || delimiter === null) {
    return false
  }
  if (
    typeof delimiter === 'function' ||
    typeof delimiter === 'object' ||
    typeof string === 'function' ||
    typeof string === 'object'
  ) {
    return {
      0: '',
    }
  }
  if (delimiter === true) {
    delimiter = '1'
  }

  // Here we go...
  const normalizedDelimiter = delimiter + ''
  const normalizedString = string + ''

  const s = normalizedString.split(normalizedDelimiter)

  if (typeof limit === 'undefined') {
    return s
  }

  // Support for limit
  if (limit === 0) {
    limit = 1
  }

  // Positive limit
  if (limit > 0) {
    if (limit >= s.length) {
      return s
    }
    return s.slice(0, limit - 1).concat([s.slice(limit - 1).join(normalizedDelimiter)])
  }

  // Negative limit
  if (-limit >= s.length) {
    return []
  }

  s.splice(s.length + limit)
  return s
}

// php/strings/split (target function module)
type SplitValue = PhpRuntimeValue

type KeyedValues = PhpAssoc<SplitValue>

function split(
  delimiter: string | boolean | null | undefined,
  string: string | KeyedValues | (() => SplitValue) | undefined,
): string[] | false | { 0: string } | null {
  //      discuss at: https://locutus.io/php/split/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //       example 1: split(' ', 'Kevin van Zonneveld')
  //       returns 1: ['Kevin', 'van', 'Zonneveld']

  return explode(delimiter, string)
}

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

  let [delimiterRaw, stringRaw, limit] = args
  let delimiter = delimiterRaw
  const string = stringRaw

  if (args.length < 2 || typeof delimiter === 'undefined' || typeof string === 'undefined') {
    return null
  }
  if (delimiter === '' || delimiter === false || delimiter === null) {
    return false
  }
  if (
    typeof delimiter === 'function' ||
    typeof delimiter === 'object' ||
    typeof string === 'function' ||
    typeof string === 'object'
  ) {
    return {
      0: '',
    }
  }
  if (delimiter === true) {
    delimiter = '1'
  }

  // Here we go...
  const normalizedDelimiter = delimiter + ''
  const normalizedString = string + ''

  const s = normalizedString.split(normalizedDelimiter)

  if (typeof limit === 'undefined') {
    return s
  }

  // Support for limit
  if (limit === 0) {
    limit = 1
  }

  // Positive limit
  if (limit > 0) {
    if (limit >= s.length) {
      return s
    }
    return s.slice(0, limit - 1).concat([s.slice(limit - 1).join(normalizedDelimiter)])
  }

  // Negative limit
  if (-limit >= s.length) {
    return []
  }

  s.splice(s.length + limit)
  return s
}

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

  return explode(delimiter, string)
}

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