https://github.com/simonguo/object-flaser

A structured object into a flat object
https://github.com/simonguo/object-flaser

Last synced: 11 months ago
JSON representation

A structured object into a flat object

• Host: GitHub
• URL: https://github.com/simonguo/object-flaser
• Owner: simonguo
• License: mit
• Created: 2018-08-27T11:09:33.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-08-31T05:47:16.000Z (almost 8 years ago)
• Last Synced: 2024-11-14T11:16:23.231Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 4.88 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# object-flaser

A structured object into a flat object.

[![NPM version](https://img.shields.io/npm/v/object-flaser.svg?style=flat)](https://npmjs.org/package/object-flaser)

[![Build Status](https://img.shields.io/travis/simonguo/object-flaser.svg?style=flat)](https://travis-ci.org/simonguo/object-flaser)

## Installation

```bash

npm install object-flaser

```

## Methods

- **flaser(target: Object, split?: string = '.')**

```js

import { flaser } from 'object-flaser';

const data = {

  user: {

    userGroup: {

      id: 1

    },

    name: {

      first: 'foo',

      last: 'bar'

    }

  }

};

flaser(data);

```

Return:

```js

{

  "user.userGroup.id": 1,

  "user.name.first": "foo",

  "user.name.last": "bar"

}

```

- **parse(target: Object, split?: string = '.')**

```js

import { parse } from 'object-flaser';

const data = {

  'user.userGroup.id': 1,

  'user.name.first': 'foo',

  'user.name.last': 'bar'

};

parse(data);

```

Return:

```js

{

  user: {

    userGroup: {

      id: 1

    },

    name: {

      first: "foo",

      last: "bar"

    }

  }

}

```