TypeScript: how to JSON stringify a class definition?

Question

Say we have:

class MyClass {
  myProperty: string
}

Is there any built in function or easy way to get JSON like this?:

{
  "myProperty": "string"
}

EDIT: My end goal is I want to dynamically print typed class definitions to a web view, in some kind of structured object syntax like JSON. I'm trying to make a server API that will return the schema for various custom classes - for example http://myserver.com/MyClass should return MyClass's properties and their types as a JSON string or other structured representation.

Nurbol Alpysbayev · Accepted Answer · 2018-11-17 04:09:05Z

1

Evert is correct, however a workaround can look like this

class MyClass {
  myProperty: string = 'string'
}

JSON.stringify(new MyClass) // shows what you want

In other words, setting a default property value lets TS compile properties to JS

If the above solution is not acceptable, then I would suggest you parsing TS files with your classes with https://dsherret.github.io/ts-simple-ast/.

edited Nov 17, 2018 at 4:09

answered Nov 17, 2018 at 3:56

Nurbol Alpysbayev

22.4k6 gold badges68 silver badges100 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Ray Zhang Over a year ago

This code returns {"myProperty":""} which is not what I want. What I want is {"myProperty":"string"}. Additionally, if myProperty was a number it should return {"myProperty":"number"} not {"myProperty":0} (for example).

Nurbol Alpysbayev Over a year ago

Sorry, I missed that part. I've updated my answer and supplied a solution (not very straight-forward one, but not too hard)

Evert · Accepted Answer · 2018-11-17 07:07:34Z

1

Typescript class properties exist at build-time only. They are removed from your source after compiling to .js. As such, there is no run-time way to get to the class properties.

Your code snippet compiles to:

var MyClass = /** @class */ (function () {
    function MyClass() {
    }
    return MyClass;
}());

As you can see, the property disappeared.

Based on your update, I had this exact problem. This is how I solved it.

My JSON-based API uses json-schema across the board for type validation, and also exposes these schemas for clients to re-use.
I used an npm package to automatically convert json-schema to Typescript.

This works brilliantly.

edited Nov 17, 2018 at 7:07

answered Nov 17, 2018 at 3:14

Evert

101k18 gold badges136 silver badges221 bronze badges

1 Comment

Evert Over a year ago

In you situation I would figure out why you need it, and based on that see if there's a more elegant solution. It's hard to tell from your question what your end-goal is.

Collectives™ on Stack Overflow

TypeScript: how to JSON stringify a class definition?

2 Answers 2

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related