array-includes-with-glob

like Lodash _.includes but with wildcards

Install

$ npm install --save array-includes-with-glob

Table of Contents

• How it works
• API
  • API - Input
    • Options object examples
  • Practical usage
  • API - Output
• Conditions when this library will throw
• Test
• Contributing & testing
• Licence

How it works

Lodash _.includes can tell, does an array contain given string among its elements:

_.includes(['abcd', 'aaa', 'bbb'], 'bc')
// => true

_.includes(['abcd', 'aaa', 'bbb'], 'zzz')
// => false

This library is a supercharged version of the Lodash _.includes, letting you to put wildcards:

includesWithGlob(['xc', 'yc', 'zc'], '*c')
// => true (all 3)

includesWithGlob(['xc', 'yc', 'zc'], '*a')
// => false (none found)

includesWithGlob(['something', 'anything', 'zzz'], 'some*')
// => true (1 hit)

Wildcard means zero or more Unicode characters.

You can also do fancy things like a wildcard in the middle of a string, or multiple wildcards in a string:

includesWithGlob(['something', 'zzz', 'soothing'], 'so*ing')
// => true (2 hits)

This library will tolerate non-string values in the source array; it will skip those values.

This library is astral-character friendly, supports all Unicode characters (including emoji) and doesn't mutate the input.

You can also query multiple values and request that ANY (default behaviour) or ALL (optional setting) should be found in the source, to yield a result "true". See examples below.

API

includesWithGlob (
  source,      // input - an array of strings or a single string
  whatToFind,  // what to look for - can contain wildcards, "*"'s, can be array of strings or a single string
  options
)

API - Input

None of the input arguments is mutated.

Options object examples

var arrayIncludesWithGlob = require('array-includes-with-glob')
var source = ['aaa', 'bbb', 'ccc']
var whatToLookFor = ['a*', 'd*']

var res1 = arrayIncludesWithGlob(source, whatToLookFor)
console.log('res1 = ' + res1)
// => res1 = true, because at one element, 'a*' was found in source (it was its first element)

var res2 = arrayIncludesWithGlob(source, whatToLookFor, {arrayVsArrayAllMustBeFound: 'all'})
console.log('res2 = ' + res2)
// => res2 = false, because not all elements were found in source: 'd*' was not present in source!

Practical usage

I need this library for my other libraries when I'm working with plain objects, and I want to let users whitelist certain keys of those objects. For example, object-merge-advanced can skip the overwrite of any keys upon request. That request technically, is an array, like ['*thing'] in the example below:

mergeAdvanced(
  { // first object to merge
    something: 'a',
    anything: 'b',
    everything: 'c'
  },
  { // second object to merge
    something: ['a'],
    anything: ['b'],
    everything: 'd'
  },
  {
    ignoreKeys: ['*thing']
  }
)

In the example above, we need to run a check through all keys of the first object and check, are any covered by the ignoreKeys array. If so, those keys would not get merged and keep their values.

API - Output

Conditions when this library will throw

This library will throw an error if:

• any of inputs is missing
• any of inputs are of the wrong type

Also, if first input argument, a source array, is an empty array or empty string, the result will always be false.

Test

$ npm test

For unit tests we use AVA, Istanbul CLI and JS Standard notation.

Contributing & testing

All contributions are welcome. Please stick to Standard JavaScript notation and supplement the test.js with new unit tests covering your feature(s).

If you see anything incorrect whatsoever, do raise an issue. If you file a pull request, I'll do my best to help you to get it merged promptly. If you have any comments on the code, including ideas how to improve things, don't hesitate to contact me by email. Everybody belong to Open Source community.

Licence

MIT License (MIT)

Copyright (c) 2017 Codsen Ltd, Roy Reveltas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.