ReturnsChainedDecorators

@tsed/schema

Usage

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

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

Overview

interface ReturnsChainedDecorators {
    <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
    (target: Function): void;
    ContentType(value: string): this;
    Description(description: string): this;
    Examples(examples: Record<string, OS3Example>): this;
    Examples(examples: Record<string, any>): this;
    Examples(examples: any): this;
    Type(type: Type<any> | any): this;
    Status(status: string | number): this;
    Of(...types: GenericValue[]): this;
    OfInteger(): this;
    OneOf(...types: GenericValue[]): this;
    AllOf(...types: GenericValue[]): this;
    AnyOf(...types: GenericValue[]): this;
    Nested(...generics: GenericValue[]): this;
    Header(key: string, value?: number | string | (JsonHeader & {
        value?: string | number | boolean;
    })): this;
    Headers(headers: JsonHeaders): this;
    Location(location: string, meta?: JsonHeader): this;
    Schema(schema: Partial<JsonSchemaObject> | JsonSchema): this;
    Title(title: string): this;
    Groups(...groups: string[]): this;
    Groups(groupName: string, groups: string[]): this;
    AllowedGroups(...allowedGroups: string[]): this;
    Binary(): this;
    [key: string]: any;
}

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

(target: Function): void;

ContentType

ContentType(value: string): this;

Set a Content-Type for the current response

Description

Description(description: string): this;

Add a description

Examples

Examples(examples: Record<string, OS3Example>): this;

Add examples

Examples

Examples(examples: Record<string, any>): this;

Examples

Examples(examples: any): this;

Type

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

Change the model type

Status

Status(status: string | number): this;

Change the status

Of

Of(...types: GenericValue[]): this;

Add the nested types

OfInteger

OfInteger(): this;

For the integer type

OneOf

OneOf(...types: GenericValue[]): this;

Add the nested types

AllOf

AllOf(...types: GenericValue[]): this;

Add the nested types

AnyOf

AnyOf(...types: GenericValue[]): this;

Add the nested types

Nested

Nested(...generics: GenericValue[]): this;

Declare a nested generic models

Header

Header(key: string, value?: number | string | (JsonHeader & {
     value?: string | number | boolean;
 })): this;

Add header.

Headers

Headers(headers: JsonHeaders): this;

Add headers

Location

Location(location: string, meta?: JsonHeader): this;

Add location hea

Schema

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

Assign partial schema

Title

Title(title: string): this;

Add an inline title for the return model.

Groups

Groups(...groups: string[]): this;

Use group to filter model

Groups

Groups(groupName: string, groups: string[]): this;

AllowedGroups

AllowedGroups(...allowedGroups: string[]): this;

Add a list of allowed groups to filter dynamically fields. Listed groups can be used by the consumer to change the mapped response.

Binary

Binary(): this;

Apply the application/octet-stream and binary format on Open API documentation

[key: string]

[key: string]: any;