# MinProperties Decorator validation swagger schema collections

Module
import { MinProperties } from "@tsed/common"
Source/packages/common/src/jsonschema/decorators/minProperties.ts

# Overview

function MinProperties(minProperties: number): (...parameters: any[]) => any;
Param Type Description
minProperties number The minimum properties allowed on the object.

# Description

An object instance is valid against minProperties if its number of properties is less than, or equal to, the value of this keyword.

WARNING

The value of this keyword MUST be a non-negative integer.

TIP

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

WARNING

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

# Example

# On prop

class Model {
   @Any()
   @MinProperties(10)
   property: any;
}
1
2
3
4
5

Will produce:

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