Skip to main content

countSubstringOccurrences

A function that returns the number of times a specific substring appears in a string.


Code​

🔗 View source code


Interface​

typescript
interface CountSubstringOccurrencesOptions {
  overlap: boolean;
}

function countSubstringOccurrences(
  source: string,
  target: string,
  options?: CountSubstringOccurrencesOptions
): number;

Usage​

typescript
import { countSubstringOccurrences } from '@modern-kit/utils';

const str = 'apple banana apple grapes apple';
const count1 = countSubstringOccurrences(str, 'apple'); // 3
const count2 = countSubstringOccurrences(str, 'apple banana'); // 1

const duplicatedStr = 'aaaa'
const count3 = countSubstringOccurrences(duplicatedStr, 'aa', { overlap: false }); // 2
const count4 = countSubstringOccurrences(duplicatedStr, 'aa', { overlap: true }); // 3