@tsed/schema/lib/esm/decorators/common/defaultMsg.js

JsonSchema module for Ts.ED Framework

import { useDecorators } from "@tsed/core";
import { ErrorMsg } from "./errorMsg.js";
/**
 * Set default error message.
 *
 * ## Example
 *
 * ```typescript
 * @DefaultMsg("foo should be a string")
 * class Model {
 *    property: number;
 * }
 * ```
 *
 * Will produce:
 *
 * ```json
 * {
 *   "type": "object",
 *   "properties": {
 *     "property": "number"
 *   }
 *   "errorMessage": {
 *     "_": "foo should be a string"
 *   }
 * }
 * ```
 *
 * @decorator
 * @validation
 * @swagger
 * @schema
 */
export function DefaultMsg(message) {
    return useDecorators(ErrorMsg({ _: message }));
}