PHP's stristr in TypeScript

How to use

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

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

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	stristr('Kevin van Zonneveld', 'Van')	'van Zonneveld'
2	stristr('Kevin van Zonneveld', 'VAN', true)	'Kevin '

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

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function stristr(haystack: string, needle: string, bool?: boolean): string | false {
  //      discuss at: https://locutus.io/php/stristr/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //       example 1: stristr('Kevin van Zonneveld', 'Van')
  //       returns 1: 'van Zonneveld'
  //       example 2: stristr('Kevin van Zonneveld', 'VAN', true)
  //       returns 2: 'Kevin '

  let pos = 0

  haystack += ''
  pos = haystack.toLowerCase().indexOf((needle + '').toLowerCase())
  if (pos === -1) {
    return false
  } else {
    if (bool) {
      return haystack.substr(0, pos)
    } else {
      return haystack.slice(pos)
    }
  }
}

export function stristr(haystack, needle, bool) {
  //      discuss at: https://locutus.io/php/stristr/
  // parity verified: PHP 8.3
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //     bugfixed by: Onno Marsman (https://twitter.com/onnomarsman)
  //       example 1: stristr('Kevin van Zonneveld', 'Van')
  //       returns 1: 'van Zonneveld'
  //       example 2: stristr('Kevin van Zonneveld', 'VAN', true)
  //       returns 2: 'Kevin '

  let pos = 0

  haystack += ''
  pos = haystack.toLowerCase().indexOf((needle + '').toLowerCase())
  if (pos === -1) {
    return false
  } else {
    if (bool) {
      return haystack.substr(0, pos)
    } else {
      return haystack.slice(pos)
    }
  }
}

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