https://github.com/nash403/get-safe

Safe access to nested properties in JS objects without getting a TypeError but undefined instead.
https://github.com/nash403/get-safe

access js-objects nested-properties typeerror

Last synced: 26 days ago
JSON representation

Safe access to nested properties in JS objects without getting a TypeError but undefined instead.

• Host: GitHub
• URL: https://github.com/nash403/get-safe
• Owner: nash403
• Created: 2016-09-14T09:48:57.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-18T12:11:09.000Z (about 7 years ago)
• Last Synced: 2024-11-23T12:51:33.424Z (about 1 month ago)
• Topics: access, js-objects, nested-properties, typeerror
• Language: JavaScript
• Size: 42 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# get-safe

> Safe access to deeply nested properties or functions in JS objects without getting a TypeError but undefined instead.

You can even call a nested function in objects if the last nested key ends with `()`. You can pass arguments by adding them as last parameters of the get-safe function call.

#### Install:

Using npm

```

npm install get-safe --save

```

Using yarn:

```bash

yarn add navscroll

```

Directly include it in html:

```html

```



Warning! The only gotcha here is Safari 10 doesn’t support the nomodule attribute, but you can solve this by inlining a JavaScript snippet in your HTML prior to using any <script nomodule> tags. (Note: this has been fixed in Safari 11).





The browser version adds the `getSafe` function to the 'window' object that you can use !



#### How to use

 ```JavaScript

const _ = require ('get-safe');

const myObj = {

  foo: {

    bar: {

      baz: ['winter','is','coming'],

      fifo (arg1, arg2) {

        console.log("I'am a function, arguments are:",...arguments);

        return 42;

      }

    }

  }

};

// Tests

console.log(_('foo.bar.baz.2',myObj)); // logs 'coming'

console.log(_('foo.bar.fifo()',myObj,'arg1','arg2')); // calls the nested function 'fifo' and logs its result

console.log(_('foo.inexistant.property.baz',myObj)); // logs 'undefined'

```

_NOTE:_ If you are **NOT** making a function call and just accessing a property, you can pass a default value as the third argument, this will be returned instead of `undefined` if the nested property doesn't exsit.