str-indexes-of-plus^2.10.12

Like indexOf but returns array and counts per-grapheme

Install via npm

npm i str-indexes-of-plus

The default is exported, so instead of indx below, you can name the consumed function however you want.

Consume via a require():

const indx = require("str-indexes-of-plus");

or as an ES Module:

import indx from "str-indexes-of-plus";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/str-indexes-of-plus/dist/str-indexes-of-plus.umd.js">

Then, you’ll get a global variable strIndexesOfPlus in your Global object and you consume it like this:

const indx = strIndexesOfPlus;

This indx is your main function. See its API in the main section.

Trivia

This program has 71 assertions in its unit tests. That's more than all unit test assertions' median (51.5) but less than geometric mean (73).

In monorepo, one other package, object-flatten-referencing, consumes this package.

§ Quick Take

import { strict as assert } from "assert";
import indx from "str-indexes-of-plus";

// searches for string in a string, returns array:
assert.deepEqual(indx("abc-abc-abc-abc", "abc"), [
  0,
  4,
  8,
  12,
]);

// all graphemes are counted as one, emoji too:
assert.deepEqual(
  indx("🐴-🦄", "🦄"),
  [2] // not [3] considering unicorn is 2-characters long
);

// you can offset the start of a search:
assert.deepEqual(indx("abczabc", "abc", 3), [4]);

⬆ back to top

§ Compared to Others

method / program	returns	index system based on
`String.prototype.indexOf()`	index where the first finding starts	code point count
`str-indexes-of`	array of indexes where each finding starts	code point count
📦 This package, `str-indexes-of-plus`	array of indexes where each finding starts	grapheme count

See this article about Unicode, graphemes and code points.

⬆ back to top

§ API

indx(
  str,
  searchValue,
  [fromIndex]
)

In other words, it's a function which takes three arguments, third one is optional (marked by square brackets).

Output: an array of zero or more numbers, each indicating the index of each finding's first character. Unicode astral characters are counted, as one character-long.

Input argument	Type	Obligatory?	Description
`str`	string	yes	Source string, where to search.
`searchValue`	string	yes	What to search for.
`fromIndex`	natural number or zero	no	If set, the searching will start from this index.