Const

@tsed/schema

Usage

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

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

Overview

function Const(constValue: JSONSchema6Type | any): (...args: any[]) => any;

Description

The const keyword is used to restrict a value to a fixed value.

WARNING

For v6 user, use Const from @tsed/schema instead of @tsed/platform-http.

Example

With a string

class Model {
   @Const("value1")
   property: "value1";
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "string",
      "const": "value1"
    }
  }
}

With a boolean

class Model {
   @Const(true)
   property: boolean;
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "boolean",
      "const": true
    }
  }
}