# MaxLength Decorator validation swagger schema input

Module
import { MaxLength } from "@tsed/schema"
Source/packages/schema/src/decorators/common/maxLength.ts

# Overview

function MaxLength(maxLength: number): (...args: any[]) => any;
Param Type Description
maxLength number The maximum length allowed

# Description

A string instance is valid against this keyword if its length is greater than, or equal to, the value of this keyword.

The length of a string instance is defined as the number of its characters as defined by RFC 7159 (opens new window).

WARNING

The value of maxLength MUST be a non-negative integer.

TIP

Omitting this keyword has the same behavior as a value of 0.

WARNING

For v6 user, use MaxLength from @tsed/schema instead of @tsed/common.

# Example

# With primitive type

class Model {
   @MaxLength(10)
   property: number;
}
1
2
3
4

Will produce:

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

# With array type

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

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
         "type": "string",
         "maxLength": 10
      }
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

Other topics