Skip to content

Integer

@tsed/schema

Usage

typescript
import { Integer } from "@tsed/schema";

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

Overview

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

Description

Set integer type.

WARNING

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

Example

typescript
class Model {
   @Integer()
   property: number;
}

Will produce:

json
{
  "type": "object",
  "properties": {
    "property": {
      "type": "integer"
    }
  }
}

With array of multiple types

typescript
class Model {
   @Integer()
   property: number[];
}

Will produce:

json
{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
         "type": "integer"
      }
    }
  }
}

Released under the MIT License.