Skip to content

Function: ODataQueryParam()

ODataQueryParam(entitySetName?): ParameterDecorator

Defined in: packages/core/src/decorators/odata-query.decorator.ts:33

Parameter decorator that extracts req.query and auto-applies ODataQueryPipe.

Usage: @Get() async getProducts(@ODataQueryParam('Products') query: ODataQuery) { ... }

The decorator passes the entitySetName as data so that the ODataQueryPipe can inject it into the query object for context URL construction and field validation.

Per D-04: auto-applies ODataQueryPipe — no @UsePipes(ODataQueryPipe) needed. Per D-05: ODataQueryPipe remains exported for advanced use cases. Per D-06: eliminates silent validation bypass when forgetting @UsePipes.

NestJS resolves ODataQueryPipe from DI automatically when a class reference is passed as the pipe argument to a createParamDecorator result.

Zero TypeORM imports — per PKG-01 architecture constraint.

Parameters

entitySetName?

string

Returns

ParameterDecorator