TSeD amalgamated class Enumeration and Gathering

Question

TSeD amalgamated class Enumeration and Gathering

Currently using TSeD version 6.38.1 Presented here is my model:

import {Any, CollectionOf, Enum, Property} from "@tsed/schema";
export enum Status {
   status1,
   status2,
   ...
}

export class FilterParams {
  ... Additional fields

  @Any(Enum(Status), CollectionOf(Enum(Status)))
  status: Status[] | Status
}

I am facing challenges in annotating the status field within FilterParams. I aim for it to be either a single Status or an array of Status

Various annotations have been attempted with no success:

```
@Enum(Status) status: Status[] | Status
```
: Only accepts a single Status, rejecting arrays of Status
@Enum(Status) status: Status: Similar to the above, only allowing single Status values
@Enum(Status) status: Status[]: Strictly requires lists of Status and does not support arrays

@Any(Enum(Status), CollectionOf(Enum(Status))) status: Status[] | Status

: Results in AJV_VALIDATION_ERROR at runtime stating

FilterParams.status.0 should be object.

How can this validation be achieved successfully in TSED?

typescript validation enums

Answer 1

Answer №1

Combining decorators in the way you've demonstrated is not supported and will not work.

To address this issue, it's best to utilize the function API for accurately defining the schema and leverage the OnDeserialize decorator to ensure that an array of Status is always maintained.

import {Any, CollectionOf, Enum, Property, string, array} from "@tsed/schema";
import {OnDeseriliaze} from "json-mapper";
export enum Status {
   status1,
   status2,
   ...
}
const StatusSchema = string().enum(Status)

export class FilterParams {
  ... Additional fields

  @AnyOf(StatusSchema, array().items(StatusSchema))
  @OnDeseriliaze(o => [].concat(o))
  status: Status[];
}

Until next time, Romain

Answer 2

Combining decorators in the way you've demonstrated is not supported and will not work.

To address this issue, it's best to utilize the function API for accurately defining the schema and leverage the OnDeserialize decorator to ensure that an array of Status is always maintained.

import {Any, CollectionOf, Enum, Property, string, array} from "@tsed/schema";
import {OnDeseriliaze} from "json-mapper";
export enum Status {
   status1,
   status2,
   ...
}
const StatusSchema = string().enum(Status)

export class FilterParams {
  ... Additional fields

  @AnyOf(StatusSchema, array().items(StatusSchema))
  @OnDeseriliaze(o => [].concat(o))
  status: Status[];
}

Until next time, Romain

TSeD amalgamated class Enumeration and Gathering

Answer №1

Similar questions

Troubleshooting Next.js and Tailwind CSS Breakpoints: What's causing the

Utilizing Angular 2 Component Input Binding with the Expression Mapping Function

Assigning object properties from a request to every item in an observable array of objects using RxJS

Error: Visual Studio unable to locate Firebase node module

Ways to convert an asynchronous operation to synchronous in JavaScript

What is the method to determine the length of a string with TypeScript?

Tips for interacting with the DOM in an Angular 4 application

What are the steps for creating and deploying a project that utilizes asp.net core on the server-side and Angular on the client-side

Issue encountered with the signature provided for a Safe API POST request

Keeping the user logged in even after closing the app in an Ionic/Angular project: Best practices to retain user sessions

The Tumblr HTML code is not valid: There is a stray start tag for `html

Looking for a specific phrase in the data entered by the user

I am looking for a way to efficiently store and reuse rxjs lettable operators in multiple `.pipe()` calls without compromising TypeScript's type safety. Can anyone suggest a method to effectively "cache

Testing the NestJS service with a real database comparison

How can union types be used correctly in a generic functional component when type 'U' is not assignable to type 'T'?

Defining a TypeScript interface specifically tailored for an object containing arrow functions

Encountered an issue when utilizing the useRef hook in Next.js version 13

Show all span elements in a map except for the last one

JavaScript code that displays values that are not equal

IDE flags an error with TypeScript type declarations