DateFormat

# DateFormat Decorator validation property parameter schema

Module
import { DateFormat } from "@tsed/schema"
Source/packages/schema/src/decorators/common/format.ts

# Overview

function DateFormat(): (...args: any[]) => any;

# Description

Apply a time validation on property.

# Example

# With primitive type

class Model {
   @Time()
   property: string;
}
1
2
3
4

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "string",
      "format": "time"
    }
  }
}
1
2
3
4
5
6
7
8
9

# With array type

class Model {
   @Time()
   @CollectionOf(String)
   property: string[];
}
1
2
3
4
5

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
         "type": "string",
         "format": "time"
      }
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

See Format decorator.

Other topics