File

src/session/dto/paginated-session-response.dto.ts

Description

Paginated response for the session list endpoint.

Index

Properties

Properties

items
Type : Session[]
Decorators :
@ApiProperty({type: undefined})

The sessions for the current page.

page
Type : number
Decorators :
@ApiProperty({description: 'Current page number (1-based)'})

Current page number (1-based).

pageSize
Type : number
Decorators :
@ApiProperty({description: 'Number of items per page'})

Number of items per page.

total
Type : number
Decorators :
@ApiProperty({description: 'Total number of sessions matching the query'})

Total number of sessions matching the query.

totalPages
Type : number
Decorators :
@ApiProperty({description: 'Total number of pages'})

Total number of pages.

import { ApiProperty } from "@nestjs/swagger";
import { Session } from "../entities/session.entity";

/**
 * Paginated response for the session list endpoint.
 */
export class PaginatedSessionResponseDto {
    /**
     * The sessions for the current page.
     */
    @ApiProperty({ type: [Session] })
    items!: Session[];

    /**
     * Total number of sessions matching the query.
     */
    @ApiProperty({ description: "Total number of sessions matching the query" })
    total!: number;

    /**
     * Current page number (1-based).
     */
    @ApiProperty({ description: "Current page number (1-based)" })
    page!: number;

    /**
     * Number of items per page.
     */
    @ApiProperty({ description: "Number of items per page" })
    pageSize!: number;

    /**
     * Total number of pages.
     */
    @ApiProperty({ description: "Total number of pages" })
    totalPages!: number;
}

results matching ""

    No results matching ""