src/core/domain/dtos/search-result.dto.ts
Elasticsearch response DTO
Properties |
constructor(code: number, data: EsResponseDto)
|
|||||||||
Defined in src/core/domain/dtos/search-result.dto.ts:38
|
|||||||||
Constructs an object with provided parameters
Parameters :
|
data |
Type : EsResponseDto
|
Decorators :
@IsDefined()
|
Defined in src/core/domain/dtos/search-result.dto.ts:38
|
All the data acquired. |
statusCode |
Type : number
|
Decorators :
@IsDefined()
|
Defined in src/core/domain/dtos/search-result.dto.ts:24
|
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;
}
}