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

JsonSchema module for Ts.ED Framework

import { DecoratorTypes } from "@tsed/core";
import { JsonEntityFn } from "./jsonEntityFn.js";
/**
 * Add optional annotation on Property or Parameter.
 *
 * @decorator
 * @validation
 * @swagger
 * @schema
 * @input
 */
export function Optional() {
    return JsonEntityFn((store) => {
        switch (store.decoratorType) {
            case DecoratorTypes.PARAM:
                store.required = false;
                break;
            case DecoratorTypes.PROP:
                store.parentSchema.removeRequired(store.propertyName);
                break;
        }
    });
}