Class UserController

UserController

Description

A controller for handling user-related requests.

Index

Constructors

Methods

getQueryParams getUserById hello index login register

Constructors

constructor

new UserController(userService: UserService): UserController
Parameters
- userService: UserService
  The user service.
Returns UserController
- Defined in controllers/UserController.ts:19

Methods

getQueryParams

getQueryParams(
    queryParams: object,
    req: IncomingMessage,
    res: ServerResponse,
): void
Parameters
- queryParams: object
  The query parameters.
- req: IncomingMessage
  The request object.
- res: ServerResponse
  The response object.
Returns void
Method
getQueryParams

Description
Gets the query parameters from the request.
- Defined in controllers/UserController.ts:118

getUserById

getUserById(
    id: string,
    req: IncomingMessage,
    res: ServerResponse,
): Promise<void>
Parameters
- id: string
  The user ID.
- req: IncomingMessage
  The request object.
- res: ServerResponse
  The response object.
Returns Promise<void>
Method
getUserById

Description
Gets a user by their ID.
- Defined in controllers/UserController.ts:84

hello

hello(req: IncomingMessage, res: ServerResponse): void
Parameters
- req: IncomingMessage
  The request object.
- res: ServerResponse
  The response object.
Returns void
Method
hello

Description
A simple hello world endpoint.
- Defined in controllers/UserController.ts:106

index

index(req: IncomingMessage, res: ServerResponse): Promise<void>
Parameters
- req: IncomingMessage
  The request object.
- res: ServerResponse
  The response object.
Returns Promise<void>
Method
index

Description
Gets all users.
- Defined in controllers/UserController.ts:28

login(
    createUserDto: CreateUserDto,
    req: IncomingMessage,
    res: ServerResponse,
): Promise<void>
Parameters
- createUserDto: CreateUserDto
  The user credentials.
- req: IncomingMessage
  The request object.
- res: ServerResponse
  The response object.
Returns Promise<void>
Method
login

Description
Logs in a user.
- Defined in controllers/UserController.ts:62

register

register(
    createUserDto: CreateUserDto,
    req: IncomingMessage,
    res: ServerResponse,
): Promise<void>
Parameters
- createUserDto: CreateUserDto
  The user data.
- req: IncomingMessage
  The request object.
- res: ServerResponse
  The response object.
Returns Promise<void>
Method
register

Description
Registers a new user.
- Defined in controllers/UserController.ts:41