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

object-viewer

v0.2.0

Published

View and listen for changes on state object that keeps track of saved vs patched state

Downloads

2

Readme

object-viewer build status

View and listen for changes on state object that keeps track of saved vs patched state.

testling badge

Example

var Viewer = require('object-viewer')
var assert = require('assert')

var base = {
  person: {
    kara: {name: 'Kara Thrace'},
    lee: {name: 'Lee Adama'}
  },
  ship: {
    galactica: {type: 'battlestar', number: 75},
    pegasus: {type: 'battlestar', number: 62}
  }
}
var viewer = Viewer(base)

viewer.on('change', function() {
  // access state via viewer.{base,patched,patch}
})

// the contents of the 'people' array
assert.deepEqual(viewer.read('person'), [
  {
    key: 'kara',
    value: {name: 'Kara Thrace'}
  },
  {
    key: 'lee',
    value: {name: 'Lee Adama'}
  }
])

// set value at key path
viewer.set('person', 'd', {name: 'Anastasia Dualla'})
// will fire a 'change' event
// see tests for more examples

Concept Overview

This is an attempt to provide a general, familiar interface to large, nested/namespaced, state objects that need to:

  • be modified and know the difference between the original state and the modified state
  • emit events when they've been changed
  • allow changes to the base state without modifying the patch

An instance of object-viewer keeps track of 3 states:

  1. base The original state
  2. patched The state after changes have been made
  3. patch The difference between the two states

The getters get and read can view any of these states by setting opts.view to the desired state. The setter is necessary to trigger events and update the patch.

Methods

var viewer = Viewer(base={}, patch={})

base is the state to diff against when determining what has changed. patch is a patch from patcher that is used to as the initial set of changes to the base state.

viewer.read(keyPath..., opts={})

Get an array of objects at the given key path in the format {key: '<key>', value: '<value>'} (the same format used by levelup).

  • opts.view = 'patched' Set which view of the state to read. options are patched, base, and patch.

viewer.get(keyPath..., opts={})

Gets the value at the given key path. opts behaves the same as in read.

viewer.set(keyPath..., value)

Gets the value at the given key path to value. set values are always set on the patch. To modify the base state, use setBase.

viewer.setBase(base={})

Sets the base state. Does not influence the patch.

viewer.applyPatch(patch={})

Applies the given patcher patch to the existing patch. Does not modify the base state.

Events

viewer.on('base', fn())

Emitted when a new base is set. Also fires when an instance is created.

viewer.on('patch', fn())

Emitted when a new patch is applied. Also fires when an instance is created.

viewer.on('change', fn())

Emitted when any value is set.

License

MIT