Does IsDecimal do what it should do?

[kaytrance]

Why IsDecimal() decorator description says that "Checks if the string contains only letters and numbers. If given value is not a string, then it returns false." and it does not check of the value was decimal or not?

While isDecimal() contains proper description and probably does that it means.

For example @IsDecimal on a field with value 123.45 passes validation while it should not, imo.

import { ValidationOptions } from '../ValidationOptions';
import ValidatorJS from 'validator';
export declare const IS_DECIMAL = "isDecimal";
/**
 * Checks if the string is a valid decimal.
 * If given value is not a string, then it returns false.
 */
export declare function isDecimal(value: unknown, options?: ValidatorJS.IsDecimalOptions): boolean;
/**
 * Checks if the string contains only letters and numbers.
 * If given value is not a string, then it returns false.
 */
export declare function IsDecimal(options?: ValidatorJS.IsDecimalOptions, validationOptions?: ValidationOptions): PropertyDecorator;

[x4th]

Why do you think 123.45 shouldn’t pass validation?

[x4th]

Under the hood this libarary uses validator, on their page, in this table you can see details about isDecimal.

[braaar]

It seems like the docstring for IsAlphanumeric has been copied over to IsDecimal

@kaytrance, judging by your description you probably want to use IsAlphanumeric for your use case.

https://github.com/typestack/class-validator/blob/develop/src/decorator/string/IsAlphanumeric.ts

/**
 * Checks if the string contains only letters and numbers.
 * If given value is not a string, then it returns false.
 */
export function isAlphanumeric(value: unknown, locale?: ValidatorJS.AlphanumericLocale): boolean {
  return typeof value === 'string' && isAlphanumericValidator(value, locale);
}

We need to update the docstring for IsDecimal

[NoNameProvided]

As @braaar said, the JSDOC was incorrect. It has been updated in 42b9ca2.

Closing as solved.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.