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

khas

v1.0.0

Published

Checks for the existence of one or more keys in a Map, Object, or other collection. Supports nesting, loose key matching, and more.

Downloads

3

Readme

khas

Checks for the existence of one or more keys in a Map, Object, or other collection. Supports nesting, loose key matching, and more.

Installation

Requires Node.js 8.3.0 or above.

npm i khas

API

The module exports a function (has()) that has other functions attached to it as methods (e.g. has.any()).

has()

Parameters

  1. Bindable: collection (Array, iterator, Map, Object, Set, string, Typed Array, or WeakMap): The key-value collection from which to retrieve a value.
  2. keychain (any, or array of any): A key to check, or an array of nested keys.
  3. Optional: Object argument:
    • arrays / maps / sets / weakMaps (arrays of classes/strings): Arrays of classes and/or string names of classes that should be treated as equivalent to Array/Map/Set/WeakMap (respectively).
    • get (function): A callback which, if provided, will override the built-in code that fetches an individual key from a collection. Use this if you need to support collections whose custom APIs preclude the use of parameters like maps. The callback will be called with five arguments: the collection, the key, the options object, the fallback to return if the key is not found, and a callback for the built-in get behavior (to which your custom get callback can defer if it determines that it doesn’t need to override the default behavior after all).
    • inObj (boolean): Whether or not to search inherited properties if collection is an Object (i.e. not another recognized type). Defaults to false.
    • loose (boolean): Whether or not to evaluate keys loosely (as defined by looselyEquals). Defaults to false.
    • looselyEquals (function): A callback that accepts two values and returns true if they are to be considered equivalent or false otherwise. This argument is only used if loose is true. If omitted, the default behavior will, among other things, consider arrays/objects to be equal if they have the same entries.

Return Value

Returns true if a value exists at the location indicated by keychain, otherwise false.

Example

const has = require('khas')

const map = new Map()
map.set('mapKey', {objKey: 'string'})

has(map, ['mapKey', 'objKey']) // true

has.any()

Has the same signature as the main function, except that the second parameter is called keychains and expects an array of keys or keychain arrays. Returns true if at least one of them points to a value, otherwise false.

Example

const has = require('khas')

has.any({c: 3, d: 4}, [['a', 'subkey'], 'b', 'c']) // true

The function tries the keys a.subkey, b, and c in that order. Since there is a value located at c, the function returns true.

has.in()

This method is an alias for calling the main has() method with the inObj option set to true.

has.any.in()

This method is an alias for calling has.any() with the inObj option set to true.

Related

The “k” family of modules works on keyed/indexed collections.

The “v” family of modules works on any collection of values.