PHP's str_split in TypeScript

How to use

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

Or with CommonJS: const { str_split } = require('locutus/php/strings/str_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	str_split('Hello Friend', 3)	['Hel', 'lo ', 'Fri', 'end']

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function str_split(
  string: string | number | boolean | null,
  splitLength?: number | string | null,
): string[] | false {
  //      discuss at: https://locutus.io/php/str_split/
  // parity verified: PHP 8.3
  //     original by: Martijn Wieringa
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //      revised by: Theriault (https://github.com/Theriault)
  //      revised by: Rafał Kukawski (https://blog.kukawski.pl)
  //        input by: Bjorn Roesbeke (https://www.bjornroesbeke.be/)
  //       example 1: str_split('Hello Friend', 3)
  //       returns 1: ['Hel', 'lo ', 'Fri', 'end']

  const normalizedSplitLength = splitLength === null || typeof splitLength === 'undefined' ? 1 : Number(splitLength)
  if (string === null || normalizedSplitLength < 1 || Number.isNaN(normalizedSplitLength)) {
    return false
  }

  const input = String(string)
  const chunks: string[] = []
  let pos = 0
  const len = input.length

  while (pos < len) {
    chunks.push(input.slice(pos, (pos += normalizedSplitLength)))
  }

  return chunks
}

export function str_split(string, splitLength) {
  //      discuss at: https://locutus.io/php/str_split/
  // parity verified: PHP 8.3
  //     original by: Martijn Wieringa
  //     improved by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //      revised by: Theriault (https://github.com/Theriault)
  //      revised by: Rafał Kukawski (https://blog.kukawski.pl)
  //        input by: Bjorn Roesbeke (https://www.bjornroesbeke.be/)
  //       example 1: str_split('Hello Friend', 3)
  //       returns 1: ['Hel', 'lo ', 'Fri', 'end']

  const normalizedSplitLength = splitLength === null || typeof splitLength === 'undefined' ? 1 : Number(splitLength)
  if (string === null || normalizedSplitLength < 1 || Number.isNaN(normalizedSplitLength)) {
    return false
  }

  const input = String(string)
  const chunks = []
  let pos = 0
  const len = input.length

  while (pos < len) {
    chunks.push(input.slice(pos, (pos += normalizedSplitLength)))
  }

  return chunks
}

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