Socket
Socket
Sign inDemoInstall

@alizeait/unflatto

Package Overview
Dependencies
0
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @alizeait/unflatto

A tiny (~210B) and fast flattened object expander, unflattener


Version published
Maintainers
1
Install size
8.92 kB
Created

Readme

Source

@alizeait/unflatto Check Coverage

A tiny (~210B) and fast flattened object expander, unflattener

Takes an already flattened object and returns a new nested object by expanding the keys.

It assumes the keys are seperated by a . by default but this can be changed to anything with the seperator option.

Installation

$ npm install @alizeait/unflatto

Usage

import { unflatto } from "@alizeait/unflatto";

const unflattened = unflatto(
{
  "key1.keyA": "valueI",
  "key2.keyB": "valueII",
  "key3.a.b.c": 2,
  "key4": [],
  "key5.a.0": "value1",
  "key5.a.1": "value2",
  "key5.a.2.key1.keyA": "valueI",
  "key5.a.2.key1.keyB.0": 1,
  "key5.a.2.key1.keyB.1": 2,
  "key5.a.2.key1.keyB.2": 3,
  "key5.a.2.key1.keyB.3": 4,
  "key5.b": null,
  "key5.c": undefined,
  "key6": {}
}

/*
{
  key1: {
    keyA: "valueI",
  },
  key2: {
    keyB: "valueII",
  },
  key3: { a: { b: { c: 2 } } },
  key4: [],
  key5: {
    a: [
      "value1",
      "value2",
      {
        key1: {
          keyA: "valueI",
          keyB: [1, 2, 3, 4],
        },
      },
    ],
    b: null,
    c: undefined,
  },
  key6: {},
});
  */

const unflattoCustom = unflatto({
  "key1-keyA": "valueI",
  "key2-keyB": "valueII",
  "key3-a-b-c": 2,
},"-");

/*
  {
    key1: {
      keyA: "valueI",
    },
    key2: {
      keyB: "valueII",
    },
    key3: { a: { b: { c: 2 } } },
  }
*/

Benchmarks

Benchmarks:

  flat.unflatten               x 63,827 ops/sec ±0.95% (89 runs sampled)
  @alizeait/unflatto           x 208,279 ops/sec ±0.84% (93 runs sampled)
  obj-unflatten                x 168,569 ops/sec ±0.68% (92 runs sampled)

Running on Node.js v12.13.0, 64-bit OS, Intel(R) Core(TM) i5-6600K CPU @ 3.50GHz, 16.0 GB RAM

Validation

Validation:

flat.unflatten               ✔
@alizeait/unflatto           ✔
obj-unflatten                ✘
  Wrongly expands arrays

API

unflatto(input: Object, seperator?:string)

Returns: Object | Array

Returns a new expanded object/array.

Keywords

FAQs

Last updated on 07 Feb 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc