Selecting logic depending on the request body in NestJS

Question

Selecting logic depending on the request body in NestJS

Currently, my controller looks like the following:

@Controller("workflow")
export class TaskWorkflowController {
  public constructor(
    private readonly jobApplicationActivityWorkflow: JobApplicationActivityService
  ) {}

  @Post("/:job-application-activity")
  public startWorkflow(
    @Body() body: StartJobApplication | StartJobActivity,
    @Param("job-application-activity") jobApplicationActivity: string
  ): void {
    switch (jobApplicationActivity) {
      case "job-application":
        return this.jobApplication.execute(body);
      case "job-activity":
        return this.jobActivity.execute(body);
      default:
        throw new Error("Invalid workflow");
    }
  }

The scenario I am facing is triggering different logic based on the job-application-activity parameter. The issue arises from having a body of type

StartJobApplication | StartJobActivity

, while my services are of type StartJobApplication and StartJobActivity.

How can I address this complication?

typescript express controller nestjs

Answer 1

Answer №1

One challenge you may encounter is the inability to perform validation because Typescript does not accurately represent the union type. However, if this limitation is not a deal-breaker for you, consider implementing a type guard instead of a switch statement. You can achieve this by:

@Controller("workflow")
export class TaskWorkflowController {
  public constructor(
    private readonly jobApplicationActivityWorkflow: JobApplicationActivityService
  ) {}

  @Post("/:job-application-activity")
  public startWorkflow(
    @Body() body: StartJobApplication | StartJobActivity,
    @Param("job-application-activity") jobApplicationActivity: string
  ): void {
    if (jobApplicationActivity.propertyOnlyOnStartJobApplication) {
        return this.jobApplication.execute(body);
    } else if(jobApplicationActivity.propertyOnlyOnStartJobActivity)
        return this.jobActivity.execute(body);
    } else {
        throw new Error("Invalid workflow");
    }
  }
}

Answer 2

One challenge you may encounter is the inability to perform validation because Typescript does not accurately represent the union type. However, if this limitation is not a deal-breaker for you, consider implementing a type guard instead of a switch statement. You can achieve this by:

@Controller("workflow")
export class TaskWorkflowController {
  public constructor(
    private readonly jobApplicationActivityWorkflow: JobApplicationActivityService
  ) {}

  @Post("/:job-application-activity")
  public startWorkflow(
    @Body() body: StartJobApplication | StartJobActivity,
    @Param("job-application-activity") jobApplicationActivity: string
  ): void {
    if (jobApplicationActivity.propertyOnlyOnStartJobApplication) {
        return this.jobApplication.execute(body);
    } else if(jobApplicationActivity.propertyOnlyOnStartJobActivity)
        return this.jobActivity.execute(body);
    } else {
        throw new Error("Invalid workflow");
    }
  }
}

Selecting logic depending on the request body in NestJS

Answer №1

Similar questions

The function is failing to return the expected value received from the observable subscription

Is there a way to navigate to a specific slide number in the nz-carousel using the goTo(slidenumber) function? I'm interested in jumping directly

Simulation service agent partnered with openApi backend

I'm encountering an issue where the database table in Postgres is not updating correctly while working with Node

I'm looking to extract various data from a SQLite table using the URL with ExpressJS. What's the best way to achieve

Messages sent to RabbitMQ through amqplib are not being received in the reply queue, even after being processed by NestJS

Executing a function in the constructor of an Angular4 component

What is the best way to transfer image files into a specific folder?

Is there a way to specify patternProperties in a JSON schema and then map it to a TypeScript interface?

Should the use of readFileSync() during the initialization of a Node.js web application be avoided?

How can I send a curl request to node.js server but receive a 200 JSON response from server.js?

Identifying asynchronous JavaScript and XML (AJAX) requests using Express in NodeJS

Vue.js 3 with TypeScript is throwing an error: "Module 'xxxxxx' cannot be located, or its corresponding type declarations are missing."

JavaScript: Trouble accessing .target property for click event in EventTarget object

In Typescript, null values are allowed even when the type is set to be non-nullable

Using a Typescript enum as a parameter type can lead to accepting incorrect values

cors library returns success messages, not errors

The Ubuntu virtual machine hosted on Google Cloud is experiencing difficulties connecting through Node.js using an external IP address

auth.js:15 Caution: The update depth has reached its maximum limit. This issue may arise if a component triggers setState within useEffect

What is the best way to avoid passing a value to a component in nextjs?