get-or-else

2.0.1 • Public • Published

get-or-else

Build status dependencies

Simple Get Or Else module written in JavaScript ES5.

Request an object property at a given namespace with a backup value, incase the desired namespace does not yield a result.

Useful if you have an untrustworthy or deeply nested data source. It will probably save you a bit of if, else-ery.

Example ES5

var get = require("get-or-else");
 
window.a = { x: 4 };
 
get([ window, 'a.b.c' ], {});
// returns {} as window.a.b.c does not exist, so `else` is used
 
get([ window, 'a' ], {});
// returns { x: 4 } as window.a does exist, so expected value is returned

Example ES6 Redux

import get from 'get-or-else';
 
export const name = (state = {}, action = {}) => {
  switch(action.type) {
    case 'SET_FIRSTNAME':
      return {
        ...state,
        firstName: get([ action, 'payload.name.first' ], undefined)
      };
    default:
      return state;
  }
};

Example ES6 React

see this repo get-or-else-demo

import React from 'react';
import ReactDOM from 'react-dom';
import get from 'get-or-else';
 
const nameObj = {
  details: {
    salutation: undefined,
    name: {
      first: 'Margaret'
    }
  }
};
 
const NameComponent = () => (
  <h1>
    Welcome {get([ nameObj, 'details.salutation' ], 'back')}
    <span> {get([ nameObj, 'details.name.first' ], '')}</span>
    <span> {get([ nameObj, 'details.name.last' ], '')}</span>
  </h1>
);
 
ReactDOM.render(
  <NameComponent />,
  document.getElementById('root')
);
 
/* NameComponent Renders `
<h1>
  Welcome back<span> Margaret</span><span></span>
</h1>`
 
nameObj.details.salutation does not exist so the backup value is used
nameObj.details.name.last does not exist so it does not display
*/

NPM Package

get-or-else

Browser compatibility

IE 9 or greater - Array.every on Mozilla's compatibility chart

Run the tests

Given you have Node installed, cd into this folder and:

npm install
npm test

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 2.0.1
    0
    • latest

Version History

Package Sidebar

Install

npm i get-or-else

Weekly Downloads

0

Version

2.0.1

License

MIT

Last publish

Collaborators

  • benbowes