UniqueItems

@tsed/schema

Usage

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

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

Overview

const UniqueItems: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(uniqueItems?: boolean) => (...args: any[]) => any>;

Description

If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.

WARNING

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

Example

class Model {
   @UniqueItems()  // default true
   property: number[];
}

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

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string"
      }
    }
  }
}