Miss any of our Open RFC calls?Watch the recordings here! »

@pelevesque/are-substrings-under-minimum-occurrences

0.0.5 • Public • Published

Build Status Coverage Status JavaScript Style Guide

are-substrings-under-minimum-occurrences

Checks if substrings are under minimum occurrences in a string.

Related Packages

https://github.com/pelevesque/are-substrings-over-maximum-occurrences
https://github.com/pelevesque/are-substrings-under-minimum-density
https://github.com/pelevesque/are-substrings-over-maximum-density

Node Repository

https://www.npmjs.com/package/@pelevesque/are-substrings-under-minimum-occurrences

Installation

npm install @pelevesque/are-substrings-under-minimum-occurrences

Tests

Command Description
npm test or npm run test All Tests Below
npm run cover Standard Style
npm run standard Coverage
npm run unit Unit Tests

Usage

Requiring

const areSubstringsUnderMinimumOccurrences = require('@pelevesque/are-substrings-under-minimum-occurrences')

One Check

// under occurrences returns true
// 'a' has 4 occurrences, less than 8
const str = 'aaaabbbb'
const checks = { a: 8 }
const result = areSubstringsUnderMinimumOccurrences(str, checks)
// result === true
// equal to occurrences returns false
const str = 'aaaabbbb'
const checks = { a: 4 }
const result = areSubstringsUnderMinimumOccurrences(str, checks)
// result === false
// over occurrences returns false
const str = 'a man, a hog, and another hog'
const checks = { hog: 1 }
const result = areSubstringsUnderMinimumOccurrences(str, checks)
// result === false

Multiple Checks

// when one is under occurrences, it returns true ('a' is under 8)
const str = 'aaaabbbb'
const checks = { a: 8, b: 4 }
const result = areSubstringsUnderMinimumOccurrences(str, checks)
// result === true
// when all are over or equal to occurrences, it returns false
const str = 'a man, a hog, and another hog'
const checks = { a: 1, hog: 1 }
const result = areSubstringsUnderMinimumOccurrences(str, checks)
// result === false

Install

npm i @pelevesque/are-substrings-under-minimum-occurrences

DownloadsWeekly Downloads

3

Version

0.0.5

License

MIT

Unpacked Size

11.3 kB

Total Files

6

Last publish

Collaborators

  • avatar