mini-json v1.0.0

❤️ mini-json

🏆 Mini tool for json parser with typescript

😍 Getting started

🛠 Install

npm install mini-json
- or -
yarn add mini-json

✈ Usage

• 📥 Object to json:

import MiniJson from 'mini-json';
const data = {
  success: true,
  data: {
    dayOfBirthday: '19/07/2020',
    name: 'mini-json'
  }
};
console.log(MiniJson.toJson(data));
/*
{
  "success": true,
  "data": {
    "day_of_birthday": "19/07/2020",
    "name": "mini-json"
  }
}
*/

• 📤 Json to object:

import MiniJson from 'mini-json';
const json = `{
  "success": true,
  "data": {
    "day_of_birthday": "19/07/2020",
    "name": "mini-json"
  }
}`;
console.log(MiniJson.fromJson(json));
/*
{
  success: true,
  data: {
    dayOfBirthday: '19/07/2020',
    name: 'mini-json'
  }
}
*/

⚙ Config

⚠ Default naming conventions of mini-json:

• toJson: camelCase to snakeCase
• fromJson: snakeCase to camelCase

🌍 Global config for naming conventions

import MiniJson from 'mini-json';
import {camelCase, kebabCase} from 'lodash';

// toJson use camelCase naming convention
MiniJson.serializeKeysTo(camelCase);

// fromJson use kebabCase naming convention
MiniJson.deserializeKeysFrom(kebabCase);

⚓ Specify naming convention

import { kebabCase, camelCase } from 'lodash';

// fromJson use kebabCase naming convention
const student = MiniJson.fromJson<Student>(json, kebabCase);

// toJson use camelCase naming convention
const json = MiniJson.toJson(obj, camelCase);

👶 Author

License

MIT