JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q41736F
  • License ISC

This package helps to create typescript types/interfaces from object or json

Package Exports

  • typesgenerator
  • typesgenerator/dist/cjs/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typesgenerator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Typesgenerator

Typesgenerator helps in creating typescript types/interfaces from JSON or JavaScript-object.

Installation and Usage

  • As Package: To use a function for printing type:

npm i -D typesgenerator

Below is usage example for printing the type from the javascript/json object:

import { printType } from 'typesgenerator';

const object = {
  name: 'john doe',
  hobbies: [
    { name: 'coding', outdoor: false },
    { name: 'cycling', outdoor: true },
  ],
  age: 35,
  score: [0, 'A', ['1st']],
};

printType(object, 'Person');

//console output:
/*
export type PersonHobbie = {
  name: string;
  outdoor: boolean;
};

export type Person = {
  name: string;
  hobbies: PersonHobbie[];
  age: number;
  score: (number | string | string[])[];
};
*/

  • As CLI: To create a typescript file from JSON:

npm i -g typesgenerator

Below is the usage example that will create a new file containing types:

tg -n <Type name> -s <path-to-json> -t <path-to-target-directory>

Below are the suppored arguments:

  • -n or -N or --type-name : Name to be given to type
  • -s or -S or --source-path : path to the json
  • (optional )-t or -T or --target-path : path to the type-file to be generated

GitHub: https://github.com/emreSlim/typescript-types-generator

Issues: https://github.com/emreSlim/typescript-types-generator/issues