Parameter decorators

@Param

Decorator that return the request path parameter value

Signature

@Param(name: string) param: string

Parameters

Parameter	Type	Required	Default	Description
parameter	string	Yes	-	The parameter name as specified in the route path

---

@Body

Decorator that return the payload after it has been transformed tot he passed class type, and validated if class-validator decorators were added to it.

Signature

@Body(dtoClass: ClassType) dto: ClassType

Parameters

Parameter	Type	Required	Default	Description
dtoClass	class	Yes	-	The dto class

---

@RawBody

Decorator that return the request path parameter value

Signature

@RawBody() body: object

---

@Query

Decorator that return the query parameter

Signature

@Query(name: string) param: string

Parameters

Parameter	Type	Required	Default	Description
name	string	Yes	-	The name of the query parameter

---

@Ip

Decorator that return the IP address from the request source

Signature

@Ip() ip: string

---

createCustomParamDecorator

A utility function that allows you to create your own paramter decorators

Signature

createCustomParamDecorator((event: H3Event) => any | Promise<any>)

---