PHP's ltrim in TypeScript

How to use

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

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

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

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function ltrim(str: string, charlist: string): string {
  //      discuss at: https://locutus.io/php/ltrim/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Erkekjetter
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //       example 1: ltrim('    Kevin van Zonneveld    ')
  //       returns 1: 'Kevin van Zonneveld    '

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

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

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

export function ltrim(str, charlist) {
  //      discuss at: https://locutus.io/php/ltrim/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //        input by: Erkekjetter
  //     improved by: Kevin van Zonneveld (https://kvz.io)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //       example 1: ltrim('    Kevin van Zonneveld    ')
  //       returns 1: 'Kevin van Zonneveld    '

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

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