@hacxy/json2ts/README.md

Json to typescript types generator

# Json2Ts

## Overview

Json2Ts is a code generation tool that transforms Json Data into Typescript types.

Targets Browsers and Node.js .

## Install

```bash
npm install @hacxy/json2ts --save
```

### Example

```ts
import json2ts from "@hacxy/json2ts";

await json2ts('{"id": 1, "name": "hacxy"}', "Root");
/**
  export interface Root {
    id: number;
    name: string;
  }
 */
```

function: `json2ts()`

> **json2ts**(`json`, `name`): `Promise`\<`string`\>

### Params

| name      | types                             | default              | description      |
| :-------- | :-------------------------------- | :------------------- | :--------------- |
| `json`    | `string`                          | `undefined`          | json data        |
| `name`    | `string`                          | `'Root'`             | define type name |
| `options` | [Json2TsOptions](#Json2TsOptions) | `{ indentation: 2 }` | Generate options |

#### Json2TsOptions

```ts
interface Json2TsOptions {
  /**
   * indentation of the generated code, default is 2 spaces
   */
  indentation?: number;
}
```

### Returns

`Promise`\<`string`\>

## Related

- json2typebox: [https://github.com/hacxy/json2typebox](https://github.com/hacxy/json2typebox)
- json2typebox-cli: [https://github.com/hacxy/json2typebox-cli](https://github.com/hacxy/json2typebox-cli)

## License

MIT