# @metamatic.net/meta-object

> A general purpose utility library to perform useful conversions to data objects.

Latest version **1.1.6** (published 2019-01-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @metamatic.net/meta-object
pnpm add @metamatic.net/meta-object
yarn add @metamatic.net/meta-object
bun add @metamatic.net/meta-object
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2019-01-02 |
| First published | 2018-12-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Heikki Kupiainen / Metamatic.net |
| Maintainers | metamatic.net |
| Keywords | object, metamatic, json, serialize |

## Links

- npm: https://www.npmjs.com/package/@metamatic.net/meta-object
- Repository: https://github.com/develprr/meta-object
- Homepage: https://github.com/develprr/meta-object#readme
- Issues: https://github.com/develprr/meta-object/issues
- npm.io page: https://npm.io/package/@metamatic.net/meta-object

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.6 (latest) — 2019-01-02
- 1.1.5 — 2019-01-02
- 1.1.4 — 2018-12-30
- 1.1.3 — 2018-12-30
- 1.1.2 — 2018-12-17
- 1.1.1 — 2018-12-17
- 1.1.0 — 2018-12-17
- 1.0.9 — 2018-12-17
- 1.0.8 — 2018-12-17
- 1.0.7 — 2018-12-17
- 1.0.6 — 2018-12-17
- 1.0.3 — 2018-12-17
- 1.0.2 — 2018-12-17
- 1.0.1 — 2018-12-17

## README

# meta-object

A general purpose utility library to perform useful conversions to data objects.

## Installation

```js
npm i @metamatic.net/meta-object
```

## Summary

* [flatten](#flatten)
* [getNestedObject](#getnestedobject)


## Object conversions

### flatten 

```js
import {flatten} from '@metamatic.net/meta-object';

const deepObject = {
  user: {
    username: 'jondoe',
    kids: ['tim', 'kim', 'jim'],
    address: {
      streetAddress: 'Somestreet 1'
    }
  }
};

const flatObject = flatten(deepObject);
```

The flattened object: 
```js
{ 
  'user.username': 'jondoe',
  'user.kids.0': 'tim',
  'user.kids.1': 'kim',
  'user.kids.2': 'jim',
  'user.address.streetAddress': 'Somestreet 1' 
}
```

### getNestedObject 

definition:
* getNestedObject(object, string)

params:
* object: any associative array
* string: path to nested object separated with dots

returns:
* object: an associative array from inside the parent object

example:

```js
import {getNestedObject} from '@metamatic.net/meta-object';

const deepObject = {
  user: {
    username: 'jondoe',
    kids: ['tim', 'kim', 'jim'],
    address: {
      streetAddress: 'Somestreet 1'
    }
  }
};

const streetAddress = getNestedObject(deepObject, 'user.adderss.streetAddress');
```

## Array Conversions

### sortByProperty

definition:
* sortByProperty(dataArray, property, sortDirection)

params:
* dataArray: array -> array of objects
* property: string -> string that defines by which property objects in array are sorted 
* sortDirection: string -> string that defins sort direction. Can have only value 'asc' or 'desc'

returns:
* array: sorted array

example:

```js
import {sortByProperty} from '@metamatic.net/meta-object/array';

const array = [
  {
    "name": "Spanish Basic Words",
    "description": "Essential Spanish vocabularies for beginners",
    "count": 30
  },
  {
    "name": "Trappistian Basics",
    "description": "Learn basics of the language spoken by our friends on Trappist 1e",
    "count": 15
  }
];

const arrayDescendingByAlphabeticalProperty = sortByProperty(array, 'description', 'desc');
const arrayAscendingByAlphabeticalProperty = sortByProperty(array, 'description', 'asc');

const arrayDescendingByNumericProperty = sortByProperty(array, 'count', 'desc');
const arrayAscendingByNumericProperty = sortByProperty(array, 'count', 'asc');

```

## License 

Apache 2.0

## Author 

[Heikki Kupiainen](https://www.linkedin.com/in/heikki-kupiainen-oppikone) / [metamatic.net](http://www.metamatic.net)

---
_Source: https://npm.io/package/@metamatic.net/meta-object · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._