PHP's chunk_split in TypeScript

How to use

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

Or with CommonJS: const { chunk_split } = require('locutus/php/strings/chunk_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	chunk_split('Hello world!', 1, '*')	'H*e*l*l*o* *w*o*r*l*d*!*'
2	chunk_split('Hello world!', 10, '*')	'Hello worl*d!*'

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function chunk_split(body: string, chunklen?: number | string, end?: string): string | false {
  //      discuss at: https://locutus.io/php/chunk_split/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //        input by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: Theriault (https://github.com/Theriault)
  //       example 1: chunk_split('Hello world!', 1, '*')
  //       returns 1: 'H*e*l*l*o* *w*o*r*l*d*!*'
  //       example 2: chunk_split('Hello world!', 10, '*')
  //       returns 2: 'Hello worl*d!*'

  const parsedChunklen = Number.parseInt(String(chunklen ?? 76), 10) || 76
  const splitEnd = end || '\r\n'

  if (parsedChunklen < 1) {
    return false
  }

  const chunks = body.match(new RegExp(`.{0,${parsedChunklen}}`, 'g')) ?? []
  return chunks.join(splitEnd)
}

export function chunk_split(body, chunklen, end) {
  //      discuss at: https://locutus.io/php/chunk_split/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //        input by: Brett Zamir (https://brett-zamir.me)
  //     bugfixed by: Kevin van Zonneveld (https://kvz.io)
  //     improved by: Theriault (https://github.com/Theriault)
  //       example 1: chunk_split('Hello world!', 1, '*')
  //       returns 1: 'H*e*l*l*o* *w*o*r*l*d*!*'
  //       example 2: chunk_split('Hello world!', 10, '*')
  //       returns 2: 'Hello worl*d!*'

  const parsedChunklen = Number.parseInt(String(chunklen ?? 76), 10) || 76
  const splitEnd = end || '\r\n'

  if (parsedChunklen < 1) {
    return false
  }

  const chunks = body.match(new RegExp(`.{0,${parsedChunklen}}`, 'g')) ?? []
  return chunks.join(splitEnd)
}

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