npm

Need private packages and team management tools?Check out npm Orgs. »

strind

0.3.1 • Public • Published

strind

NPM Build Coverage

Partition strings based on character indices.

Install

yarn add strind

Usage

import strind from 'strind';
 
const result = strind('abcd', [[1, 1], [2, 6]]);
 
console.log(result);
/**
 * {
      matched: ['b', 'cd'],
      unmatched: [
        {
          chars: 'a',
          index: 0
        }
      ]
    }
 *
 */

Callback

An optional callback function can be passed as the third argument.

The function is called with the substring chars and boolean matches if the substring matches the array indices.

import strind from 'strind';
 
const result = strind('abcd', [[1, 1], [2, 6]], ({ chars, matches }) => {
  return {
    text: chars,
    isHighlighted: matches
  };
});
 
console.log(result);
/**
 * [
      { isHighlighted: false, text: 'a' },
      { isHighlighted: true, text: 'b' },
      { isHighlighted: true, text: 'cd' }
    ]
 *
 */

Changelog

License

MIT

install

npm i strind

Downloadsweekly downloads

75

version

0.3.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability