# MaxItems Decorator validation swagger schema input collections

Module
import { MaxItems } from "@tsed/schema"
Source/packages/schema/src/decorators/collections/maxItems.ts

# Overview

function MaxItems(maxItems: number): (...args: any[]) => any;

# Description

The value maxItems MUST be a non-negative integer.

An array instance is valid against maxItems if its size is less than, or equal to, the value of this keyword.

:: warning The value maxItems MUST be a non-negative integer. :::

:: warning This decorator will be removed in v7. For v6 user, use MaxItems from @tsed/schema instead of @tsed/common. :::

# Example

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

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "number",
      "maxItems": 10
    }
  }
}
1
2
3
4
5
6
7
8
9

Other topics