src/people/dtos/response/get-people.dto.ts
Data Transfer Object for paginated response of people. This DTO extends the PaginationResponseDto with PersonDto as the type parameter. It is used to return a list of people with pagination information.
Properties |
| data |
Type : T[]
|
Decorators :
@ApiProperty({description: 'The data property contains the paginated data', type: 'array', items: undefined})
|
|
Inherited from
PaginationResponseDto
|
|
Defined in
PaginationResponseDto:69
|
|
The data property contains the paginated data. |
| links |
Type : literal type
|
Decorators :
@ApiProperty({description: 'The links property contains information about the pagination links', type: 'object', properties: undefined})
|
|
Inherited from
PaginationResponseDto
|
|
Defined in
PaginationResponseDto:110
|
|
The links property contains information about the pagination links. |
| meta |
Type : literal type
|
Decorators :
@ApiProperty({description: 'The meta property contains information about the pagination', type: 'object', properties: undefined})
|
|
Inherited from
PaginationResponseDto
|
|
Defined in
PaginationResponseDto:86
|
|
The meta property contains information about the pagination. |
| paginated |
|
Inherited from
PaginationResponseDto
|
|
Defined in
PaginationResponseDto:57
|
|
The paginated property indicates whether the data is paginated or not. this is not a part of the response |
import { PaginationResponseDto } from 'src/common/pagination/dtos/pagination.dto';
import { PersonDto } from '../helper/person.dto';
/**
* Data Transfer Object for paginated response of people.
* This DTO extends the PaginationResponseDto with PersonDto as the type parameter.
* It is used to return a list of people with pagination information.
*/
export class GetPeopleRequestDto extends PaginationResponseDto<PersonDto> {}