C's string.strchr in JavaScript

Rosetta Stone: php/strchr

How to use

You you can install via yarn add locutus and require this function via const strchr = require('locutus/c/string/strchr').

It is important to use a bundler that supports tree-shaking so that you only ship the functions that you actually use to your browser, instead of all of Locutus, which is massive. Examples are: Parcel, webpack, or rollup.js. For server-side use this is typically less of a concern.

Examples

Please note that these examples are distilled from test cases that automatically verify our functions still work correctly. This could explain some quirky ones.

#	code	expected result
1	`strchr('Hello, World!', 'o')`	`'o, World!'`
2	`strchr('Hello', 'x')`	`null`

C types and JavaScript

C is statically typed while JavaScript is dynamically typed. Locutus C functions accept JavaScript's flexible types but are only parity-verified for inputs that would be valid in C.

For example, abs() in JavaScript accepts floats (like C's fabs()) and handles strings gracefully, but only integer inputs are verified against native C. This pragmatic approach gives you the expected C behavior for valid inputs while leveraging JavaScript's flexibility for edge cases.

Notes

Returns a pointer to the first occurrence of c in str. In JS, returns the substring starting from the first occurrence, or null.

Here's what our current JavaScript equivalent to C's strchr found in the string.h header file looks like.

module.exports = function strchr(str, c) {
  //  discuss at: https://locutus.io/c/string/strchr/
  // original by: Kevin van Zonneveld (https://kvz.io)
  //      note 1: Returns a pointer to the first occurrence of c in str.
  //      note 1: In JS, returns the substring starting from the first occurrence, or null.
  //   example 1: strchr('Hello, World!', 'o')
  //   returns 1: 'o, World!'
  //   example 2: strchr('Hello', 'x')
  //   returns 2: null

  str = str + ''
  c = (c + '').charAt(0)
  const idx = str.indexOf(c)
  return idx === -1 ? null : str.slice(idx)
}

Think you can do better?

Not unlike Wikipedia, Locutus is an ongoing community effort. Our philosophy follows The McDonald’s Theory. This means that we assimilate first iterations with imperfections, hoping for others to take issue with-and improve them. This unorthodox approach has worked very well to foster fun and fruitful collaboration, but please be reminded to use our creations at your own risk. THE SOFTWARE IS PROVIDED "AS IS" has never been more true than for Locutus.

Now go and: [ View on GitHub | Edit on GitHub | View Raw ]

Ehm.. only 18 C functions?

We can use your help porting more. Have a rainy Sunday afternoon to spare and a taste for a porting puzzle?

Get inspiration from the C math.h documentation, the C math.h source.
Click "New file" in the appropriate folder on GitHub. This will fork the project to your account, directly add the file to it, and send a Pull Request to us.

We will then review it. If it's useful to the project and in line with our contributing guidelines your work will become part of Locutus and you'll be automatically credited in the authors section accordingly.

« More C string functions

Star