MaxItems

@tsed/schema

Usage

typescript

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

See /packages/specs/schema/src/types/decorators/collections/maxItems.ts.

const MaxItems: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(maxItems: number) => (...args: any[]) => any>;

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/platform-http. :::

typescript

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

Will produce:

json

{
  "type": "object",
  "properties": {
    "property": {
      "type": "number",
      "maxItems": 10
    }
  }
}