Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/parameter-decorators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ import {
/**
* Set the ParameterProvider on a Handler or Property.
*
* @param target Controller class
* @param target Decorator target: the prototype of the decorated member, whose
* constructor is the controller class
* @param key Handler key or Property key
* @param index If used on a handler, parameter index
* @param provider ParameterProvider
Expand Down Expand Up @@ -58,7 +59,8 @@ export function SetParameterProvider<
/**
* Add a ParameterModifier on a Handler or Property.
*
* @param target Controller class
* @param target Decorator target: the prototype of the decorated member, whose
* constructor is the controller class
* @param key Handler key or Property key
* @param index If used on a handler, parameter index
* @param transformer ParameterModifier
Expand Down
9 changes: 8 additions & 1 deletion src/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,21 @@ function handlerSegment(
/**
* Register a RouteHandler to the API from a decorator.
*
* @param target Controller class
* @param target Decorator target: the prototype of the decorated method, whose
* constructor is the controller class
* @param key Handler key
* @param descriptor Handler descriptor
* @param route Handler mode (prefix, handler, postfix, websocket), HTTP method,
* endpoint location and handler priority, in that order; the location and the
* priority are optional
* @returns `{ id }`, an object because {@link Route} returns it as a method
* decorator's property descriptor
* @throws {TypeError} When the descriptor has no `value`, because the decorated
* member is not a method
* @throws {TypeError} When `target.constructor` is a class that
* `Controller` did not create, so it has no location; a static method's
* target is the class itself, whose constructor is `Function`
* @throws {TypeError} When `key` is a symbol and the route gives no location
* @throws {TypeError} When a parameter of the handler receives `@Connection`,
* set on it or inherited from a parent controller's method of the same name,
* and the mode is neither `websocket` nor `monitor`
Expand Down
Loading