Skip to content

Latest commit

 

History

History
178 lines (125 loc) · 4.26 KB

README.md

File metadata and controls

178 lines (125 loc) · 4.26 KB
Raw

json-to-kotlin-class


JSON to Kotlin Class

Raw javascript to convert JSON to Kotlin Class
Explore the docs »

· Report Bug · Request Feature

Dead Simple to Use

# Import Package
const jsonToKotlinClass = require("json-to-kotlin-class");

# Your JSON
const json = { key: "value" };

# Call init function to initiate conversion
console.log(jsonToKotlinClass.init(json));

Resultant: A Kotlin Data Class

data class JsonToKotlinMain (val key: String, )
Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Sponsor

About The Package

This package is created to generate respective Kotlin Class from a given JSON.

Built With

This package is built with raw javascript and Mocha / Chai is used for testing.

Getting Started

Install this package and follow examples given below. We have examples folder which has implementation code as well.

Installation

  1. Install NPM packages 
    npm i --save json-to-kotlin-class

Usage

Once this package is added in your project as mentioned in the installation, you need to import this package and call init function to initiate conversion.

Eg:

# Import Package
const jsonToKotlinClass = require("json-to-kotlin-class");

# Your JSON
const json = { key: "value" };

# Call init function to initiate conversion
console.log(jsonToKotlinClass.init(json));

Resultant: A Kotlin Data Class

data class JsonToKotlinMain (val key: String, )

INPUT: JSON

{
  "string": "string",
  "char": "c",
  "int": 123456,
  "double": 2020.2,
  "boolean": true,
  "array": [1, 2, 2020.2],
};

OUTPUT: Kotin Class

data class JsonToKotlinMain (val string: String, val char: Char, val int: Int, val double: Double, val boolean: Boolean, val array: Array<Double>, )

Test

Test cases is written in test/test.js. To test this package, run npm run test.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

SANKET MAKHIJA - @sanket_dude - sanket[dot]mahija[at]gmail[dot]com

Sponsor ❤️

Consider sponsoring this package and help open source community and contributions.