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

ikwin-object

v1.0.1

Published

IKWIN object.

Downloads

1

Readme

ikwin-object aka objexp

Think of it as a regular expression for objects.

You simply create an object that describes a sample data structure

const sample = {
  items: [
    {
      id: 0,
      name: ''
    }
  ]
}

which is your regular expression that reads:

an object with a property `items` of a type of an array
  that holds objects with proerties:
    `id` of a type of a number
     and
    `name` of a type of a string.

and ready to be applied to a source object like so:

objexp(source).match(sample)

Why do you need that?

Imagine you receive a gigantic json object from an API endpoint and you're looking for some data in it that may or may not be there.

response.data.data.catalog.categories.clearance.items...

So you need to make sure that a sibling you're looking for and all its parents are there. But even when you've got those items you need to access their properties carefully, because what if they are not there? The code that does that usually has many if statements and replicated everywhere you trying to access received data.

With the objexp it's all gone as the data is not only located but also automatically validated against a sample object.

Such approach also promotes loose contracts between clients and APIs because it does not matter how big your object is and where data you're looking for in it.

Methods

match()

Locates an object alike in an object.

objexp(source).match(sample)
Parameters

sample - A sample object used as an expression to match an object alike in a source object.

Return value

An object containing the entire match result or null if there were no matches.

validate()

Validates an object against a sample object.

objexp(source).validate(sample)
Parameters

sample - A sample object used as an expression to validate a source object against.

Return value

An array of missing items or an empty array in case of successful validation.

Install

npm install ikwin-object

Use

ES5

var objexp = require('ikwin-object').default

ES6

import objexp from 'ikwin-object'

IKWIN

ikwin-object is a utility function to support IKWIN pattern. Learn more about IKWIN:

https://github.com/appmux/ikwin