PHP's chop in TypeScript

How to use

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

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

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	chop(' Kevin van Zonneveld ')	' Kevin van Zonneveld'

Dependencies

This function uses the following Locutus functions:

• rtrim (php/strings)

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

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

export function chop(str: string, charlist: string): string {
  //      discuss at: https://locutus.io/php/chop/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //       example 1: chop('    Kevin van Zonneveld    ')
  //       returns 1: '    Kevin van Zonneveld'

  return rtrim(str, charlist)
}

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

export function chop(str, charlist) {
  //      discuss at: https://locutus.io/php/chop/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //       example 1: chop('    Kevin van Zonneveld    ')
  //       returns 1: '    Kevin van Zonneveld'

  return rtrim(str, charlist)
}

// php/strings/rtrim (Locutus dependency module)
function rtrim(str?: string, charlist?: string): string {
  //      discuss at: https://locutus.io/php/rtrim/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Erkekjetter
  //        input by: rem
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //       example 1: rtrim('    Kevin van Zonneveld    ')
  //       returns 1: '    Kevin van Zonneveld'

  if (typeof str === 'undefined') {
    throw new Error('rtrim() expects at least 1 argument, 0 given')
  }

  charlist = !charlist ? ' \\s\u00A0' : (charlist + '').replace(/([[\]().?/*{}+$^:])/g, '\\$1')

  const re = new RegExp('[' + charlist + ']+$', 'g')

  return (str + '').replace(re, '')
}

// php/strings/chop (target function module)
function chop(str: string, charlist: string): string {
  //      discuss at: https://locutus.io/php/chop/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //       example 1: chop('    Kevin van Zonneveld    ')
  //       returns 1: '    Kevin van Zonneveld'

  return rtrim(str, charlist)
}

// php/strings/rtrim (Locutus dependency module)
function rtrim(str, charlist) {
  //      discuss at: https://locutus.io/php/rtrim/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Erkekjetter
  //        input by: rem
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //     bugfixed by: Brett Zamir (https://brett-zamir.me)
  //       example 1: rtrim('    Kevin van Zonneveld    ')
  //       returns 1: '    Kevin van Zonneveld'

  if (typeof str === 'undefined') {
    throw new Error('rtrim() expects at least 1 argument, 0 given')
  }

  charlist = !charlist ? ' \\s\u00A0' : (charlist + '').replace(/([[\]().?/*{}+$^:])/g, '\\$1')
  const re = new RegExp('[' + charlist + ']+$', 'g')
  return (str + '').replace(re, '')
}

// php/strings/chop (target function module)
function chop(str, charlist) {
  //      discuss at: https://locutus.io/php/chop/
  // parity verified: PHP 8.3
  //     original by: Paulo Freitas
  //       example 1: chop('    Kevin van Zonneveld    ')
  //       returns 1: '    Kevin van Zonneveld'

  return rtrim(str, charlist)
}

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