https://github.com/themgoncalves/transform-object-dot-notation

Transform object string dot notation into object reference
https://github.com/themgoncalves/transform-object-dot-notation

babel babel-plugin dotnotation object transformer

Last synced: 6 days ago
JSON representation

Transform object string dot notation into object reference

• Host: GitHub
• URL: https://github.com/themgoncalves/transform-object-dot-notation
• Owner: themgoncalves
• License: mit
• Created: 2019-03-22T15:27:51.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-23T11:54:36.000Z (almost 6 years ago)
• Last Synced: 2025-01-17T23:16:51.014Z (28 days ago)
• Topics: babel, babel-plugin, dotnotation, object, transformer
• Language: JavaScript
• Size: 103 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# transform-object-dot-notation

> Transform object string dot notation into object reference

[![NPM][npm-image]][npm-url]

[![CircleCI][circle-ci-image]][circle-ci-url]

[![GitHub All Releases][releases-image]][releases-url]

[![GitHub stars][stars-image]][stars-url]

[![Known Vulnerabilities][vulnerabilities-image]][vulnerabilities-url]

[![GitHub issues][issues-image]][issues-url]

[![Awesome][awesome-image]][awesome-url]

## Example

### Accessing deeply nested properties

```js

const obj = {

  foo: {

    bar: {

      baz: {

        val: 'hello world',

      },

    },

  },

};

const val = obj['foo.bar.baz.val']  // hello world

```

### Calling deeply nested functions

```js

const obj = {

  foo: {

    bar: {

      baz: class {

      },

    },

  },

};

const baz = new obj['foo.bar.baz'] // baz instance

```

### Constructing deeply nested classes

```js

const obj = {

  foo: {

    bar: {

      baz: function() {

        return 'hello world'

      },

    },

  },

};

const baz = obj['foo.bar.baz']() // hello world

```

### With `Optional Chaining` Proposal

```js

const obj = {

  foo: {

    bar: {

      baz: 30,

    },

  },

};

const safe = obj['foo?.quiz?.baz'] // undefined

```

In this case, `transform-object-dot-notation` **should be placed before** [`@babel/plugin-proposal-optional-chaining`](https://babeljs.io/docs/en/babel-plugin-proposal-optional-chaining)




## Installation

```sh

npm install --save-dev @themgoncalves/transform-object-dot-notation

```

**Note**: `transform-object-dot-notation` **should be ** listed in the `devDependencies`.




## Usage

### Via `.babelrc` (Recommended)

**.babelrc**

```javascript

{

 "plugins": ["@themgoncalves/transform-object-dot-notation"]

}

```




### Via CLI

```bash

$ babel --plugins @themgoncalves/transform-object-dot-notation script.js

```

### Via Node API

```bash

require("@babel/core").transform("code", {

  plugins: ["@themgoncalves/transform-object-dot-notation"]

});

```




## Release History

* 0.1.2

    * FIX: `optional chaining` transform

    * DEPRECATE: `optionalChaining` option. Usage no longer requires settings specification.

* 0.1.1

    * First release

    * NEW: `optionalChaining` option

* 0.0.1

    * Work in progress




## Meta

### Author

**Marcos Gonçalves** – [LinkedIn](http://linkedin.com/in/themgoncalves/) – [Website](http://www.themgoncalves.com)

### License

Distributed under the MIT license. [Click here](/LICENSE) for more information.

[https://github.com/themgoncalves/transform-object-dot-notation](https://github.com/themgoncalves/transform-object-dot-notation)

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b feature/fooBar`)

3. Commit your changes (`git commit -m ':zap: Add some fooBar'`)

4. Push to the branch (`git push origin feature/fooBar`)

5. Create a new Pull Request

[circle-ci-url]: https://circleci.com/gh/themgoncalves/transform-object-dot-notation

[circle-ci-image]: https://circleci.com/gh/themgoncalves/transform-object-dot-notation.svg?style=svg

[vulnerabilities-image]: https://snyk.io/test/github/themgoncalves/transform-object-dot-notation/badge.svg

[vulnerabilities-url]: https://snyk.io/test/github/themgoncalves/transform-object-dot-notation

[issues-image]: https://img.shields.io/github/issues/themgoncalves/transform-object-dot-notation.svg

[issues-url]: https://github.com/themgoncalves/transform-object-dot-notation/issues

[stars-image]: https://img.shields.io/github/stars/themgoncalves/transform-object-dot-notation.svg

[stars-url]: https://github.com/themgoncalves/transform-object-dot-notation/stargazers

[forks-image]: https://img.shields.io/github/forks/themgoncalves/transform-object-dot-notation.svg

[forks-url]: https://github.com/themgoncalves/transform-object-dot-notation/network

[awesome-image]: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg

[releases-image]: https://img.shields.io/github/downloads/atom/atom/total.svg

[releases-url]: https://github.com/themgoncalves/transform-object-dot-notation

[awesome-url]: https://github.com/themgoncalves/transform-object-dot-notation

[npm-image]: https://img.shields.io/npm/v/@themgoncalves/transform-object-dot-notation.svg

[npm-url]: https://www.npmjs.com/package/@themgoncalves/transform-object-dot-notation