npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@eddaic/nestjs-decorators

v1.8.0

Published

Additional decorators intended for use with NestJS framework.

Downloads

610

Readme

nestjs-decorators

A variety of decorators, pipes and transformers intended for use with NestJS framework.

Included with each decorator are Swagger ApiProperty definitions to reduce boiler plate in DTOs.

Installation

npm install @eddaic/nestjs-decorators

Decorators

  • ApiPropertyBigInt
  • ApiPropertyBigIntOptional
  • ApiPropertyDate
  • ApiPropertyDateOptional
  • ApiPropertyInt
  • ApiPropertyIntOptional
  • IsBigInt
  • ParseBigIntPipe
  • SplitString
  • TransformBigInt
  • TransformInt
  • Trim

Examples

ParseBigIntPipe

Pipe parameters as bigint values, raising BadRequestException if unable to tranform.

import { ParseBigIntPipe } from '@eddaic/nestjs-decorators';
import { Controller, Get, Param } from '@nestjs/common';

@Controller()
export class AppController {
  @Get(':id')
  async getId(@Param('id', ParseBigIntPipe) id: bigint): bigint {
    return id;
  }
}

ApiPropertyBigInt, ApiPropertyBigIntOptional, IsBigInt, TransformBigInt

Validate bigint values or transform decimal values to bigint through a rounding policy.

import {
  ApiPropertyBigInt,
  ApiPropertyBigIntOptional,
  IsBigInt,
  RoundingPolicy,
  TransformBigInt,
} from '@eddaic/nestjs-decorators';
import { IsNumber, IsOptional } from 'class-validator';

export class MyDto {
  @IsBigInt()
  @ApiPropertyBigInt()
  id: bigint;

  @IsBigInt()
  @IsOptional()
  @ApiPropertyBigIntOptional()
  limit?: bigint;

  @IsNumber()
  @TransformBigInt({ rounding: RoundingPolicy.CEIL })
  @ApiPropertyBigInt()
  ceil: bigint;
}

ApiPropertyInt, TransformInt

Transform decimal values to integer number values through a rounding policy.

import {
  ApiPropertyInt,
  RoundingPolicy,
  TransformInt,
} from '@eddaic/nestjs-decorators';
import { IsNumber } from 'class-validator';

export class MyDto {
  @IsNumber()
  @TransformInt({ rounding: RoundingPolicy.FLOOR })
  @ApiPropertyInt()
  floor: number;
}

Transforming Arrays

import {
  ApiPropertyInt,
  RoundingPolicy,
  TransformInt,
} from '@eddaic/nestjs-decorators';
import { IsNumber } from 'class-validator';

export class MyDto {
  @IsNumber({ each: true })
  @TransformInt({ each: true, rounding: RoundingPolicy.FLOOR })
  @ApiPropertyInt({ isArray: true })
  floors: number[];
}

ApiPropertyDate, ApiPropertyDateOptional

import {
  ApiPropertyDate,
  ApiPropertyDateOptional,
} from '@eddaic/nestjs-decorators';
import { IsDate, IsOptional } from 'class-validator';

export class MyDto {
  @IsDate()
  @ApiPropertyDate()
  date: date;

  @IsDate()
  @IsOptional()
  @ApiPropertyDateOptional()
  optional_date?: date;
}

SplitString

Returns string array using specified separator (defaults to ,). Supporting RegExp also.

import { SplitString } from '@eddaic/nestjs-decorators';
import { ApiProperty } from '@nestjs/swagger';
import { IsString, IsNotEmpty } from 'class-validator';

export class MyDto {
  @IsString({ each: true })
  @SplitString({ separator: '|' })
  @ApiProperty({ isArray: true, type: 'string' })
  strings: string[];
}

Combined with TransformInt

import { SplitString, TransformInt } from '@eddaic/nestjs-decorators';
import { ApiProperty } from '@nestjs/swagger';
import { IsNumber } from 'class-validator';

export class MyDto {
  @IsNumber({ each: true })
  @SplitString({ separator: ',' })
  @TransformInt({ each: true })
  @ApiPropertyInt({ isArray: true })
  integers: number[];
}

Trim

import { Trim } from '@eddaic/nestjs-decorators';
import { ApiProperty } from '@nestjs/swagger';
import { IsString, IsNotEmpty } from 'class-validator';

export class MyDto {
  @IsString()
  @IsNotEmpty()
  @Trim()
  @ApiProperty()
  nonEmptyString: string;
}