Pattern

@tsed/schema

Usage

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

See /packages/specs/schema/src/types/decorators/common/pattern.ts.

Overview

const Pattern: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(pattern: string | RegExp) => (...args: any[]) => any>;

Description

The pattern and Pattern Properties keywords use regular expressions to express constraints. The regular expression syntax used is from JavaScript (ECMA 262, specifically). However, that complete syntax is not widely supported, therefore it is recommended that you stick to the subset of that syntax described below.

WARNING

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

A single unicode character (other than the special characters below) matches itself.

• ^: Matches only at the beginning of the string.
• $: Matches only at the end of the string.
• (...): Group a series of regular expressions into a single regular expression.
• |: Matches either the regular expression preceding or following the | symbol.
• [abc]: Matches any of the characters inside the square brackets.
• [a-z]: Matches the range of characters.
• [^abc]: Matches any character not listed.
• [^a-z]: Matches any character outside of the range.
• +: Matches one or more repetitions of the preceding regular expression.
• *: Matches zero or more repetitions of the preceding regular expression.
• ?: Matches zero or one repetitions of the preceding regular expression.
• +?, *?, ??: The *, +, and ? qualifiers are all greedy; they match as much text as possible. Sometimes this behavior isn’t desired and you want to match as few characters as possible.
• {x}: Match exactly x occurrences of the preceding regular expression.
• {x,y}: Match at least x and at most y occurrences of the preceding regular expression.
• {x,}: Match x occurrences or more of the preceding regular expression.
• {x}?, {x,y}?, {x,}?`: Lazy versions of the above expressions.

Example

class Model {
   @Pattern("^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$")
   @Pattern(/^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$/)
   property: string;
}

With primitive type

class Model {
   @Pattern(/^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$/)
   property: string;
}

{
  "type": "object",
  "properties": {
    "property": {
      "type": "string",
      "pattern": "^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$"
    }
  }
}

With array type

class Model {
   @CollectionOf(string)
   @Pattern(/^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$/)
   property: string[];
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$"
      }
    }
  }
}