File

src/core/domain/dtos/search-result.dto.ts

Description

Elasticsearch response DTO

Index

Properties

Constructor

constructor(code: number, data: EsResponseDto)

Constructs an object with provided parameters

Parameters :
Name Type Optional
code number No
data EsResponseDto No

Properties

data
Type : EsResponseDto
Decorators :
@IsDefined()
@IsNotEmpty()
@IsArray()
@ApiProperty({description: 'Data acquired from the Elasticsearch', example: undefined})

All the data acquired.

statusCode
Type : number
Decorators :
@IsDefined()
@IsNotEmpty()
@IsInt()
@ApiProperty({description: 'Status code', example: 200})

Status code

import { ApiProperty } from "@nestjs/swagger";
import { IsArray, IsDefined, IsInt, IsNotEmpty, IsOptional, IsString } from "class-validator";
import { EsResponseDto } from "./es-response.dto";

/**
 * List of allowed properties in this DTO
 */
const allowedProperties = ['data', 'status'];

/**
 * Elasticsearch response DTO
 */
export class SearchResultDto {
    /**
     * Status code
     */
    @IsDefined()
    @IsNotEmpty()
    @IsInt()
    @ApiProperty({
        description: 'Status code',
        example: 200,
    })
    statusCode: number;
    
    /**
     * All the data acquired.
     */
    @IsDefined()
    @IsNotEmpty()
    @IsArray()
    @ApiProperty({
        description: 'Data acquired from the Elasticsearch',
        example: {
            
        },
    })
    data: EsResponseDto;

    /**
     * Constructs an object with provided parameters
     * @param code 
     * @param data 
     */
    constructor(code: number, data: EsResponseDto) {
        this.statusCode = code;
        this.data = data;
    }
}

results matching ""

    No results matching ""