Schema

@tsed/schema

Usage

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

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

Overview

function Schema<T>(partialSchema: Partial<JsonSchemaObject> | JsonSchema<T>): (...args: any[]) => any;

Description

Write data formatted to JsonSchema.

Example

@Schema({title: "test"})
class Model {
   @Schema({formatMinimum: "1987-10-24"})
   @Format("date")
   birthDate: Date
}

Will produce:

{
  "type": "object",
  "title": "test",
  "properties": {
    "birthdate": {
       "type": "string",
       "format": "date",
       "formatMinimum": "1987-10-24"
    }
  }
}