has_required_substrings
Checks if a string has required substrings.
Related Packages
https://github.com/pelevesque/has_prohibited_substring
https://github.com/pelevesque/has_required_substrings_at_indexes
https://github.com/pelevesque/has_prohibited_substring_at_indexes
https://github.com/pelevesque/has_required_substrings_after_sums
https://github.com/pelevesque/has_prohibited_substring_after_sums
Node Repository
https://www.npmjs.com/package/@pelevesque/has_required_substrings
Installation
npm install @pelevesque/has_required_substrings
Tests
Standard Style & Unit Tests
npm test
Unit Tests & Coverage
npm run cover
Usage
Parameters
default = falseRequiring
const hasRequiredSubstrings = Basic Usage
requiredSubstrings is an array of substrings. true is returned if all
substrings are found.
const str = 'abcde'const requiredSubstrings = 'f'const result = // result === falseconst str = 'abcde'const requiredSubstrings = 'a'const result = // result === trueconst str = 'abcde'const requiredSubstrings = 'a' 'b' 'f'const result = // result === falseconst str = 'abcde'const requiredSubstrings = 'a' 'b' 'c'const result = // result === trueconst str = 'a man a plan a canal'const requiredSubstrings = 'man' 'plan' 'canal'const result = // result === trueOptions
allowLastSubstringToBleed
The allowLastSubstringToBleed option is false by default. It it used when you want
to allow the last substring to be incomplete if the string is too short.
In the following example, the last substring canal starts at the correct index,
but remains incomplete since the string ends. Normally this would return false.
With allowLastSubstringToBleed set to true, it returns true.
const str = 'a man a plan a c'const requiredSubstrings = 'man' 'plan' 'canal'const allowLastSubstringToBleed = trueconst result = // result === trueoptions style
For style compatibility with related packages like has_required_substrings_after_sums,
it is possible to set allowLastSubstringToBleed using an options style.
const str = 'a man a plan a c'const requiredSubstrings = 'man' 'plan' 'canal'const allowLastSubstringToBleed = trueconst result = // result === true