Any way to indicate that a string is actually a date-time? about ts-json-schema-generator HOT 7 CLOSED

export class Whatever {
  /** @format date-time */
  aDateString: string;
}

This seems to be the way.

I don't even remember how I figured this out myself, because it is undocumented. Supported tags can be found in the source: https://github.com/vega/ts-json-schema-generator/blob/next/src/AnnotationsReader/BasicAnnotationsReader.ts

from ts-json-schema-generator.

Can you describe how that should look like in the schema? It may already be possible.

from ts-json-schema-generator.

@domoritz It would just be a string type with a format of date-string:

      "properties": {
        "awarded_at": {
          "type": "string"
          "format": "date-time"
        }
      },

The problem here is that in my TS file, the awarded_at property is typed as a simple string, not a Date.

from ts-json-schema-generator.

Don't we have support for format already?

from ts-json-schema-generator.

Yes, but only if the type of the property in the TS file is a Date. In my case it's a string. It happens to be a string that is an iso-8601 date-time and I'd like to be able to have that fact reflected in the schema.

from ts-json-schema-generator.

Example with comments that illustrates the point:

export class Whatever {
  /**
   * This is a string, but it happens to be an ISO-8601 encoded time.   I don't want to have to go
   * through the trouble of parsing this into an actual Date instance when it comes off the wire.
   * I want to leave it as a string to keep the marshaling code simple.  But it would be nice if
   * there were a way for me to annotate this property somehow to tell ts-json-schema-generator
   * that, while this is "just" a string, it should use the date-time format in the schema.
   */
  aDateString: string;
}

from ts-json-schema-generator.

Beautiful. Honestly, I can't believe I didn't just try that. Thanks!

from ts-json-schema-generator.