PHP's strcspn in TypeScript

How to use

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

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

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	strcspn('abcdefg123', '1234567890')	7
2	strcspn('123abc', '1234567890')	0
3	strcspn('abcdefg123', '1234567890', 1)	6
4	strcspn('abcdefg123', '1234567890', -6, -5)	1

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function strcspn(str: string, mask: string, start?: number, length?: number): number {
  //      discuss at: https://locutus.io/php/strcspn/
  // parity verified: PHP 8.3
  //     original by: Brett Zamir (https://brett-zamir.me)
  //      revised by: Theriault
  //       example 1: strcspn('abcdefg123', '1234567890')
  //       returns 1: 7
  //       example 2: strcspn('123abc', '1234567890')
  //       returns 2: 0
  //       example 3: strcspn('abcdefg123', '1234567890', 1)
  //       returns 3: 6
  //       example 4: strcspn('abcdefg123', '1234567890', -6, -5)
  //       returns 4: 1

  start = start || 0
  length = typeof length === 'undefined' ? str.length : length || 0
  if (start < 0) {
    start = str.length + start
  }
  if (length < 0) {
    length = str.length - start + length
  }
  const e = Math.min(str.length, start + length)
  if (start < 0 || start >= str.length || length <= 0) {
    return 0
  }
  let lgth = 0
  for (let i = start; i < e; i++) {
    if (mask.includes(str.charAt(i))) {
      break
    }
    ++lgth
  }
  return lgth
}

export function strcspn(str, mask, start, length) {
  //      discuss at: https://locutus.io/php/strcspn/
  // parity verified: PHP 8.3
  //     original by: Brett Zamir (https://brett-zamir.me)
  //      revised by: Theriault
  //       example 1: strcspn('abcdefg123', '1234567890')
  //       returns 1: 7
  //       example 2: strcspn('123abc', '1234567890')
  //       returns 2: 0
  //       example 3: strcspn('abcdefg123', '1234567890', 1)
  //       returns 3: 6
  //       example 4: strcspn('abcdefg123', '1234567890', -6, -5)
  //       returns 4: 1

  start = start || 0
  length = typeof length === 'undefined' ? str.length : length || 0
  if (start < 0) {
    start = str.length + start
  }
  if (length < 0) {
    length = str.length - start + length
  }
  const e = Math.min(str.length, start + length)
  if (start < 0 || start >= str.length || length <= 0) {
    return 0
  }
  let lgth = 0
  for (let i = start; i < e; i++) {
    if (mask.includes(str.charAt(i))) {
      break
    }
    ++lgth
  }
  return lgth
}

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