npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-refactor

v1.0.0

Published

Refactor JSON object structure based on provided rules.

Downloads

6

Readme

json-refactor

Refactor JSON object structure based on provided rules.

quick start

npm install json-refactor --save

import refactor from 'json-refactor';
const result = refactor(target, rules, clone);
  • target: target to be refactored
  • rules: rules to refactor
  • clone: default false, whether to clone a copy of target. By default, the original target will be modified and return. If true, a new cloned target will be formatted and return, and the original target will not be modified.

rules

The to key to from key hash map.

1. base

target: {a: 1, b: 2}

rules: {aaa: 'a', bbb: 'b'}

result: {aaa: 1, bbb: 2}

2. rules should have the same structure with target, including array

target: [{a: 1, b: 2}, {a: 3, b: 4}, {a: 5, b: 6}]

rules: [{aaa: 'a', bbb: 'b'}]

result: [{aaa: 1, bbb: 2}, {aaa: 3, bbb: 4}, {aaa: 5, bbb: 6}]

3. support . semantic

target: {a: {a: {a: 1}}}

rules: {aaa: 'a.a.a'}

result: {aaa: 1}

4. make a new key, and keep on formatting the new key

target: {a: {a: {a: 1}}}

rules: {aaa: 'a', _aaa: {aaa: 'a', _aaa: {aaa: 'a'}}}

result: {aaa: {aaa: {aaa: 1}}}

5. take an operator to original value

Use | to concat from key and operator, and you can add multiple operators.

target: {a: 1, b: '234', c: '1.22', d: '0.01'}

rules: {aaa: 'a|bool', bbb: 'b|int', ccc: 'c|float', ddd: 'd|int|bool'}

result: {aaa: true, bbb: 234, ccc: 1.22, ddd: false}

api

refactor.set

Set the default config values.

refactor.set({
  keepOnHandling: '_',
  operatorDelimiter: '|'
});
  • keepOnHandling: make a new key, and keep on formatting the new key

    • type: string
    • default: _
  • operatorDelimiter: delimiter of operators

    • type: string
    • default: |

refactor.register

Register operators.

// register one operator
refactor.register(test, handler);
refactor.register({test, handler});

// register multiple operators
refactor.register([{test1, handler1}, {test2, handler2}, ...]);
  • test: to match the operator

    • type: string/RegExp
    • example: int, float, bool, string, /^slice!0!10/
  • handler: handle the original value and return a new value

    • type: function
    • example: (value, operator) => newValue
    • parameters: value, operator
      • value: original value to be handled
      • operator: operator matched

built-in operators

1. int

Get an integer value.

2. float

Get a float value.

3. bool

Get a bool value.

4. string

Get a string value.

5. sum

Get a sum value specified by a key of each element, within an array.

format: sum!key

target: {oldKey: [{a: 1, b: 2}, {a: 3, b: 4}, {a: 5, b: 6}]}

rules: {newKey: 'oldKey|sum!a'}

result: {newKey: 9}

6. average

Get an average value specified by a key of each element, within an array.

format: average!key

target: {oldKey: [{a: 1, b: 2}, {a: 3, b: 4}, {a: 5, b: 6}]}

rules: {newKey: 'oldKey|average!a'}

result: {newKey: 3}