• Preparing search index...
  • The search index is not available
zibri
  • zibri
  • open-api/decorators/response.decorator
  • Response
  • paginated

Function paginated

  • paginated(
        entityClass: Newable<unknown>,
        data?: OmitStrict<JsonOpenApiResponse, "type" | "cls" | "isArray">,
    ): MethodDecorator

    A paginated result json response.

    Parameters

    • entityClass: Newable<unknown>

      The class that defines the paginated items response structure.

    • Optionaldata: OmitStrict<JsonOpenApiResponse, "type" | "cls" | "isArray">

      Additional configuration, like status or description.

    Returns MethodDecorator

    • Defined in src/open-api/decorators/response.decorator.ts:73

Settings

Member Visibility
zibri
  • Loading...

Generated using TypeDoc