Required

# Required Decorator validation swagger schema input

Module
import { Required } from "@tsed/schema"
Source/packages/schema/src/decorators/common/required.ts

# Overview

function Required(required?: boolean, ...allowedRequiredValues: any[]): any;

# Description

Add required annotation for a function argument.

The @Required decorator can be used on two cases.

To decorate a parameters:

@Post("/")
async method(@Required() @BodyParams("field") field: string) {}
1
2

To decorate a model:

class Model {
  @Required()
  field: string;
}
1
2
3
4

Required will throw a BadRequest when the given value is null, an empty string or undefined.

# Allow a values

In some case, you didn't want trigger a BadRequest when the value is an empty string for example. The decorator @Allow(), allow you to configure a value list for which there will be no exception.

class Model {
  @Allow("") // add automatically required flag
  field: string;
}
1
2
3
4

Other topics