how to force a field to be a specific type?

[benny-medflyt]

I am trying to do something like:

/**
* How to force a Widget to be encoded as number?
*
* @type number
*/
export interface Widget {}

export interface House {
    name: string;

    mainWidget: Widget;
    otherWidgets: Widget[];
}

So that the mainWidget field is encoded as a regular "number", and also otherWidgets will be an array of numbers.

In other words I would like to get the following schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "properties": {
        "name": {
            "type": "string"
        },
        "mainWidget": {
            "type": "number"
        },
        "otherWidgets": {
            "items": {
                "type": "number"
            },
            "type": "array"
        }
    },
    "required": [
        "name",
        "mainWidget",
        "otherWidgets"
    ],
    "type": "object"
}

thank you

[domoritz]

Yes, you have to use:

/** @TJS-type integer */

See microsoft/TypeScript#13498 for the reason why this is necessary.

[benny-medflyt]

Hi, I tried using @TJS-type but I don't think it helps me in this case

[domoritz]

Can you send a pull request with a test case? Thanks!

[benny-medflyt]

Sent as #83

[domoritz]

The issue is that we try to infer types and defintions and overriding properties can have weird effects. I added some code so it works for types but I'm not convinced that it's a good idea in general to let users override properties.

[benny-medflyt]

Thanks, this is amazing! But i have found a small bug i think when importing type from another module. I've added another test case in #84

[domoritz]

Thanks @benny-medflyt! Do you think you could look into a fix for the issue?

[benny-medflyt]

I'm not familiar with typescript-json-schema source code, but maybe in a few days I'll have time to try to figure this out