npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

shallow-contains

v1.0.1

Published

partial shallow equality comparison between two values

Downloads

675

Readme

shallow-contains

Partial shallow equality comparison between two values

Installation

npm i --save shallow-contains

Usage

Supports both ESM and CommonJS

// esm
import shallowContains from 'shallow-contains'
// commonjs
const shallowContains = require('shallow-contains').default

Signature: shallowContains(value, contains, [comparator])

/**
 * value {any} value to check if it contains 'contains'
 * contains {object|array|map|set} keys and/or values to check if the exist in 'value'
 * comparator {function} custom comparator for comparing values
 */

Example: object shallow contains...

import shallowContains from 'shallow-contains'

// ... keys and values from an object
const obj = { foo: 1, bar: 2, qux: 3 }
shallowContains(obj, { bar: 2, qux: 3 }) // true
// ... keys and values from a map
shallowContains(obj, new Map([['bar', 2], ['qux', 3]])) // true
// ... values from an array
shallowContains(obj, [2, 3]) // true
// ... values from a set
shallowContains(obj, new Set([2, 3])) // true
// ... custom comparator
shallowContains(obj, { foo: /1/, bar: 2 }, (a, b) => b.test ? b.test(a) : a === b) // true

Example: map shallow contains...

import shallowContains from 'shallow-contains'

// ... keys and values from an object
const map = new Map([['foo', 1], ['bar', 2], ['qux', 3]]
shallowContains(map, { bar: 2, qux: 3 }) // true
// ... keys and values from a map
shallowContains(map, new Map([['bar', 2], ['qux', 3]])) // true
// ... values from an array
shallowContains(map, [2, 3]) // true
// ... values from a set
shallowContains(map, new Set([2, 3])) // true
// ... custom comparator
shallowContains(map, { foo: /1/, bar: 2 }, (a, b) => b.test ? b.test(a) : a === b) // true

Example: array shallow contains...

import shallowContains from 'shallow-contains'

const arr = [1, 2, 3]
// ... values from an array
shallowContains(arr, [2, 3]) // true
// ... values from a set
shallowContains(arr, new Set([2, 3])) // true
// ... custom comparator
shallowContains(arr, [/2/], (a, b) => b.test ? b.test(a) : a === b) // true

// note: these don't make sense and will return false
// ... keys and values from an object
shallowContains(arr, { bar: 2, qux: 3 }) // true
// ... keys and values from a map
shallowContains(arr, new Map([['bar', 2], ['qux', 3]])) // true

Example: set shallow contains...

import shallowContains from 'shallow-contains'

const set = new Set([1, 2, 3])
// ... values from an array
shallowContains(set, [2, 3]) // true
// ... values from a set
shallowContains(set, new Set([2, 3])) // true
// ... custom comparator
shallowContains(set, [/2/], (a, b) => b.test ? b.test(a) : a === b) // true

// note: these don't make sense and will return false
// ... keys and values from an object
shallowContains(set, { bar: 2, qux: 3 }) // true
// ... keys and values from a map
shallowContains(set, new Map([['bar', 2], ['qux', 3]])) // true

Example: Custom Comparator

const obj = { foo: 'value1', bar: 'value2', qux: 'value3' }
shallowContains(obj, { foo: /value/, bar: 'value2' }, (a, b) => b.test ? b.test(a) : a === b) // true

License

MIT