get-text-indices

A tool to help you find the start and the end index of a part of a string

Table of contents

• Installation
• Documentation
  1. Usage in JavaScript
  2. Using the provided types in TypeScript
• Contributing
• License

Installation

npm install get-text-indices

Or, if you prefer yarn

yarn add get-text-indices

Documentation

There is only a single function exported from this module which is getTextIndices(). The first argument of that function is the string to search in, the second argument is the string to search in the first argument, and the fourth argument, which is optional is the options object, in the option you can specify if you want a case-sensitive search or not, by using the caseSensitive option, by default case-sensitivity is on and you can also specify whether you want to have multiple matches returned or not using the multiple option.

Usage in JavaScript

const { getTextIndices } = require('get-text-indices');

// To find the first match with case-sensitivity on
console.log(getTextIndices('a SAMPLE sample sentence', 'sample')); // [ { start: 9, end: 14 } ]

// To find multiple matches with case-sensitivity on
console.log(
  getTextIndices('a SAMPLE sample sentence', 'sample', { multiple: true })
); // [ { start: 9, end: 14 } ]

// To find the first match with case-sensitivity off
console.log(
  getTextIndices('a SAMPLE sentence', 'sample', { caseSensitive: false })
); // [ { start: 2, end: 7 } ]

// To find multiple matches with case-sensitivity off
console.log(
  getTextIndices('a SAMPLE sample sentence', 'sample', {
    caseSensitive: false,
    multiple: true,
  })
); // [ { start: 2, end: 7 }, { start: 9, end: 14 } ]

// When no result is found then it returns an empty array
console.log(getTextIndices('', 'sample')); // []

Using the provided types in TypeScript

import {
  getTextIndices,
  GetTextIndicesSearchResult,
  GetTextIndicesOptions,
} from 'get-text-indices';

const options: GetTextIndicesOptions = { caseSensitive: false };

const result: GetTextIndicesSearchResult[] = getTextIndices(
  'sample sentence',
  'sample',
  options
);

console.log(result); // [ { start: 0, end 5 } ]

Contributing

Contributions are welcome! See the contribution guide for more info.

License

This software is licensed under the MIT License. See the LICENSE for more info