InChainedDecorators

@tsed/schema

Usage

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

See /packages/specs/schema/src/types/decorators/operations/in.ts.

Overview

interface InChainedDecorators {
    <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
    (target: Object, propertyKey: string | symbol, parameterIndex: number): void;
    (target: Function): void;
    Type(type: Type<any>): this;
    Name(name: string): this;
    Description(description: string): this;
    Required(required?: boolean): this;
    Pattern(pattern: string | RegExp): this;
    Schema(schema: Partial<JsonSchemaObject | JsonSchema>): this;
}

<T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;

(target: Object, propertyKey: string | symbol, parameterIndex: number): void;

(target: Function): void;

Type

Type(type: Type<any>): this;

Type of this in parameter

Name

Name(name: string): this;

Description

Description(description: string): this;

Required

Required(required?: boolean): this;

Pattern

Pattern(pattern: string | RegExp): this;

Add pattern constraint. Only available for OPENAPI.

Schema

Schema(schema: Partial<JsonSchemaObject | JsonSchema>): this;

Add custom schema.