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

nest-safely

v2.0.0

Published

[![Build Status](https://travis-ci.org/kylehovey/nest-safely.svg?branch=master)](https://travis-ci.org/kylehovey/nest-safely) ![License](https://img.shields.io/packagist/l/doctrine/orm.svg) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b64b7

Downloads

6

Readme

:link: Nest Safely

Build Status License Codacy Badge

TL;DR:

Turn this:

const data = { deeply : { nested : { source : { why : 42 } } } };

if (data.deeply && data.deeply.nested && data.deeply.nested.source) {
  console.log(data.deeply.nested.source.why);
}

Into this:

const data = { deeply : { nested : { source : { why : 42 } } } };

console.log(
  Safe(data).deeply.nested.source.why
    [Safe.or]("Nothing found.")
    [Safe.value]
);

The Details

Despite allowing remarkable flexibility and ease of use, when accessing objects in JavaScript it doesn't take long before you run into this sort of error:

const data = { deeply : { nested : { source : 42 } } };
const val = data.deeply.not.here;

// Uncaught TypeError: Cannot read property 'here' of undefined
//  at <anonymous>:2:29

Many libraries exist to solve the problem of accessing deeply nested values in an object, but they all seem to use evaluated strings of access keys like:

const data = { deeply : { nested : { source : 42 } } };
const val = access(data, "deeply.not.here", "nothing");
console.log(val); // nothing

I found this too awkward to use in my code, so I decided to make an improvement using functional programming! I implemented a basic Maybe monad, then used the shiny new ES6 Proxy object to allow for deep object access (and more!) using minimally added syntax. Here's an example:

const Safe = require("nest-safely");

const data = Safe({ deeply : { nested : { source : 42 } } });

const val = data.deeply.no.way.anything.is.here[Safe.or]("nothing was found")[Safe.value];

console.log(val); // "nothing was found"

Notice the use of an additional term [Safe.or] in the chain. You can think of each . in the sequence as a .then in a Promise chain inasmuch as any undefined access will fall through to the end. In this case, a default value is provided to the [Safe.or] method which will not have its functionality invoked if the value has not dropped out in the sequence:

const Safe = require("nest-safely");

const data = Safe({ deeply : { nested : { source : 42 } } });

const val = data.deeply.nested.source.[Safe.or]("nothing was found")[Safe.value];

console.log(val); // 42

The only other piece of machinery added is a [Safe.value] getter keyword that will unwrap the value out of the chain. Optionally, a [Safe.handle] method may also be used where you can supply a function that will be given the last value seen in the chain before null or undefined was encountered.

const Safe = require("nest-safely");

const data = Safe({ deeply : { nested : { source : 42 } } });

const val = data.deeply.nested.does.not.have
  [Safe.handle](last => `Last seen: ${JSON.stringify(last)}`)
  [Safe.value];

console.log(val); // Last seen: { "source" : 42 }

And, just like a Promise chain, [Safe.or] or [Safe.handle] can be located anywhere in the chain:

const Safe = require("nest-safely");

const data = Safe({ deeply : { nested : { source : 42 } } });

const val = data.deeply.nested.does.not.have
  [Safe.or]({ x : { y : 34 } })
  .x
  .nope
  [Safe.handle](last => `Last seen: ${JSON.stringify(last)}`)
  [Safe.value];

console.log(val); // Last seen: { "y" : 42 }

I hope this small 40-line library is useful for you! If you have suggestions, make an issue and I'll be happy to look over it.