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

@universal-packages/object-mapper

v1.1.5

Published

Object mapper utility for analysis or recomposition

Downloads

50,690

Readme

Object Mapper

npm version Testing codecov

For those not so common situations where you just want to know the composition of a complex object to analyze and probably recompose such object.

Install

npm install @universal-packages/object-mapper

Global methods

mapObject(subject: Object, [options, callback)

Will traverse an object recursively and will generate a record for every property in it describing it, or if a property is an object will map it as a object map as well. If the object mapper finds a loop in the hierarchy it will reference the previously processed object map for the object that creates the loop.

import { mapObject } from '@universal-packages/object-mapper'

const result = mapObject({ hola: 'hello' })

// > {
// >   id: 0,
// >   level: 0,
// >   properties: { hola: { descriptor: undefined, propertyKey: 'hola', level: 0, type: 'string', value: 'hello' } },
// >   type: 'object'
// > }

Options

  • ignoreInaccessible boolean default: true Some properties in the prototype chain can't be accessed in any way, you can get an error of this event or just ignore those properties

  • ignoreLevelsBeyondMaxDepth boolean If a property is in a level beyond the max you can ignore it or get an error of the event.

  • keyInspector 'simple' | 'prototypeChain' default: simple A simple key inspector will getOwnPropertyNames to get properties from the object, or you can opt to get all properties going all up the prototype chain, useful to get properties inherited in classes.

  • maxDepth number Max level the recursive traversal can reach

  • propertyFilter

    • include RegExp | string[] include only matching property names.

      import { mapObject } from '@universal-packages/object-mapper'
      
      const options = {
        propertyFilter: { include: ['property1', 'property3'] }
      }
      
      const result = mapObject({ property1: '1', property2: '2', property3: '3' }, options)
      
      console.log(result)
      
      // > { properties: { property1: { ... }, property3: { ... } } }
    • exclude RegExp | string[]

      import { mapObject } from '@universal-packages/object-mapper'
      
      const options = {
        propertyFilter: { exclude: ['property1', 'property3'] }
      }
      
      const result = mapObject({ property1: '1', property2: '2', property3: '3' }, options)
      
      console.log(result)
      
      // > { properties: { property2: { ... } } }

Callback

Use a callback for every value visited to use it or modify it in any way in the original object.

import { mapObject } from '@universal-packages/object-mapper'

const result = mapObject({ hola: 'hello' }, null, (value: any): any => {
  return 'other value post processing it'
})

console.log(result)

//> {
//>   id: 0,
//>   level: 0,
//>   properties: { hola: { descriptor: undefined, propertyKey: 'hola', level: 0, type: 'string', value: 'other value post processing it' } },
//>   type: 'object'
//> }

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.