Dealing with errors in an inversify controller

Question

Dealing with errors in an inversify controller

I am currently utilizing the inversify-express-utils library.

Let's say I have a controller action that is responsible for retrieving a User entity:

  @httpGet("/:id")
  public async getUser(): Promise<User> {
    try {
      const id = this.httpContext.request.params.id;
      return await this._userRepository.get(id);
    }
    catch (e) {
      this.httpContext.response.status(404);
      // ...what should be included here?
    }
  }

I understand that I can exclude the return type, but I prefer not to bypass the type system.

So, what should I include in the catch block?

typescript inversifyjs

Answer 1

Answer №1

If you decide to throw again, feel free to throw whatever you prefer because often the rejected value is not correctly typed (e.g. it is any).

lib.es5.d.ts:

interface Promise<T> {
    then<TResult1 = T, TResult2 = never>(
        onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
        // Refer to `reason` below
        onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
    ): Promise<TResult1 | TResult2>;

Some may argue that Promise should have two specific type parameters...

If you do catch and return a value, make sure it is of type User as specified. It seems more like a rejection to encounter a 404 error, but if the library does not handle rejections properly, you may need to return a value.

You might want to consider changing the return type to User | null if rejection is not possible, so you can return null in case of failure.

Answer 2

If you decide to throw again, feel free to throw whatever you prefer because often the rejected value is not correctly typed (e.g. it is any).

lib.es5.d.ts:

interface Promise<T> {
    then<TResult1 = T, TResult2 = never>(
        onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,
        // Refer to `reason` below
        onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
    ): Promise<TResult1 | TResult2>;

Some may argue that Promise should have two specific type parameters...

If you do catch and return a value, make sure it is of type User as specified. It seems more like a rejection to encounter a 404 error, but if the library does not handle rejections properly, you may need to return a value.

You might want to consider changing the return type to User | null if rejection is not possible, so you can return null in case of failure.

Dealing with errors in an inversify controller

Answer №1

Similar questions

Can ES6 class getters, setters, and private properties be utilized in TypeScript with an interface?

Experimenting with the routerLink directive in Angular 2

A guide on assigning a boolean value to a property during an action using NGXS

Angular 7: struggling to locate the type declaration file

Troubleshooting Nested Handlebars Problem

Steps for confirming a property setting on an interface

Request NPM to fetch the complete TypeScript source code, not limited to just the *.d.ts files

An improved approach for implementing ngClass condition in Angular components

Encountering an error when attempting to show user details on a webpage using Angular and Ionic with Promise functionality

Error TS2307: Module 'angular' could not be located

The error message "Cannot read property 'firestore' of undefined" is often encountered when

JSON Object Key passed as a parameter in a function

Oops! Looks like we've encountered a bit of a snag: HttpClient provider is missing

Angular directive for displaying telephone numbers in the USA format

No provider for aspnetcore-spa routing

React Hook Form: Reset function triggers changes across all controllers on the page

What is the best way to define this.someProperty in a React component using TypeScript?

The mat table is not displaying the values from the API despite receiving the correct array

Executing asynchronous dispatch in TypeScript from a frontend component

Explain the const/type pattern in TypeScript