https://github.com/cdaringe/primitivify

deep copy data keeping only primitives in nested data structures
https://github.com/cdaringe/primitivify

clone json primitives serialization stringify

Last synced: about 1 month ago
JSON representation

deep copy data keeping only primitives in nested data structures

• Host: GitHub
• URL: https://github.com/cdaringe/primitivify
• Owner: cdaringe
• Created: 2019-10-25T23:54:58.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T02:42:00.000Z (9 months ago)
• Last Synced: 2024-04-11T14:59:33.206Z (8 months ago)
• Topics: clone, json, primitives, serialization, stringify
• Language: TypeScript
• Homepage:
• Size: 844 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# primitivify

deep copy data keeping only primitives in nested data structures. useful for serializing complex objects where you only care about the raw data contained within.

"primitive-ify"

[![TypeScript package](https://img.shields.io/badge/language-typescript-blue)](https://www.typescriptlang.org)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## install

`npm install --save primitivify`

## usage

the best demonstration of the value of this module is exemplified from the tests!

```ts

import primitivify from "primitivify";

const dummyFn = () => {};

const complex = {

  dummyFn,

  a: {

    b: {

      c: setTimeout(() => {}, 0),

    },

    d: setInterval(dummyFn, 1e3),

  },

  b: [dummyFn, "wee", { e: "e" }],

};

t.deepEqual(

  {

    // observe how non-primitive datas are nulled away

    dummyFn: null,

    a: {

      b: {

        c: null,

      },

      d: null,

    },

    b: [null, "wee", { e: "e" }],

  },

  primitivify(complexObj),

  "complex"

);

```

primitivify is immutable--calls return deeply cloned values.

need a _custom_ serializer? use the 2nd argument, `onVisit`, to transform the current value being inspected:

```ts

primitivify(

  { a: () => {} },

  v => typeof v === 'function' ? 'wee' : v)

)

// { a: 'wee' }

```

### why

generally to decomplect objects and/or arrays. consinder a simple example:

```js

JSON.stringify({ usefulData: "beep", a: setTimeout(() => {}, 0) });

/*

Thrown:

TypeError: Converting circular structure to JSON

    --> starting at object with constructor 'Timeout'

    |     property '_idlePrev' -> object with constructor 'TimersList'

    --- property '_idleNext' closes the circle

    at JSON.stringify ()

*/

JSON.stringify(primitivify({ a: setTimeout(() => {}, 0) }));

/*

'{"usefulData":"beep","a":null}'

*/

```