Naphthalene Possum Management

    @atton16/validator-decorators
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    validator-decorators

    A collection of validator decorators. Fully compatible with class-validator, NestJS and TypeScript.

    Installation

    npm install @atton16/validator-decorators

    Usage

    import { IsNumeral, IsInCaseInsensitive } from '@atton16/validator-decorators';
    
    class Prize {
      @IsNumeral()
      rank: string;
    
      @IsInCaseInsensitive(['medal', 'silver', 'bronze'])
      label: string;
    }

    Validation decorators

    Decorator Description
    @IsInCaseInsensitive(values: any[]) Checks if value is in a array of allowed values. (Case-insensitive)
    @IsNumeral(culture?: string) Checks if value passed numeral.validate() validation.
    @IsEqualToProperty(property: string, opts?: ComparePropertyOptions) Checks if value is strictly equal to the value of given property.
    @IsGreaterThanOrEqualToProperty(property: string, opts?: ComparePropertyOptions) Checks if value is greater than or equal to the value of given property.
    @IsGreaterThanProperty(property: string, opts?: ComparePropertyOptions) Checks if value is greater than the value of given property.
    @IsLessThanOrEqualToProperty(property: string, opts?: ComparePropertyOptions) Checks if value is less than or equal to the value of given property.
    @IsLessThanProperty(property: string, opts?: ComparePropertyOptions) Checks if value is less than the value of given property.

    Compare Property Options

    The Compare Property Options (ComparePropertyOptions) allows the value of both value to be transformed before performing comparison checks.

    The transform function A (transformA) transform the current field's value.

    The transform function B (transformB) transform the given property's value.

    License

    ISC License

    Copyright (c) 2020, Attawit Kittikrairit

    Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

    Install

    npm i @atton16/validator-decorators

    DownloadsWeekly Downloads

    4

    Version

    1.1.1

    License

    ISC

    Unpacked Size

    446 kB

    Total Files

    67

    Last publish

    Collaborators

    • atton16-org