TimeFormat

@tsed/schema

Usage

import { TimeFormat } from "@tsed/schema";

See /packages/specs/schema/src/types/decorators/common/format.ts.

Overview

const TimeFormat: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<() => import("../../utils/withErrorMsg.js").ErrorChainedMethods<(format: JsonFormatTypes | ValueOf<JsonFormatTypes>) => (...args: any[]) => any>>;

Description

Apply a time validation on property.

Example

With primitive type

class Model {
   @TimeFormat()
   property: string;
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "string",
      "format": "time"
    }
  }
}

With array type

class Model {
   @TimeFormat()
   @CollectionOf(String)
   property: string[];
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
         "type": "string",
         "format": "time"
      }
    }
  }
}