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

nestjs-swagger-api-http-response-decorators

v3.2.0

Published

Small npm package that exports 'Api' decorators for all HTTP status codes available on @nestjs/common package, to use with @nestjs/swagger.

Downloads

14

Readme

nestjs-swagger-api-http-response-decorators

npm version npm downloads supported nestjs versions

demo

Installation

npm i @nestjs/swagger nestjs-swagger-api-http-response-decorators
# or
yarn add @nestjs/swagger nestjs-swagger-api-http-response-decorators

What

Taking the following TypeScript enumerate as an example:

enum HttpStatus {
  CONTINUE = 100,
  SWITCHING_PROTOCOLS = 101,
  PROCESSING = 102,
  EARLYHINTS = 103
  // ...
}

this small package exports @ApiXResponse(opts) decorator factories (read more about them here) for each enum field listed above, including the ones already available on @nestjs/swagger package.

The X part will be the name of that enum field in pascal case.
eg: HTTP_VERSION_NOT_SUPPORTED becomes HttpVersionNotSupported

In order to make this package as lean as possible, only decorators there are not available in @nestjs/swagger are implemented. The other ones are exported as-is via export * from '@nestjs/swagger'.

Why

@nestjs/swagger does not have @ApiX decorators for all available HTTP status code out there (and this is why they export the @ApiResponse), and "There are no plans to add more decorators.".

How index.ts is being created?

I'm lazy, thus I made two simple scripts to generate the TypeScript code from missing @ApiX decorators, relying on HttpStatus enum exported from @nestjs/common package.

Using the following tools:

  • wget
  • grep
  • sha1sum
  • Node.js

This is how to generate the index.ts (on root dir.) file:

$ npm ci

$ cd scripts
$ ./fetch-missing-decorators.sh
$ ./generate-index-ts-file.js

$ cd ../meta
$ sha1sum missing > missing.sha1
$ # ... later on, repeat the whole process and then
$ sha1sum -c missing.sha1

Development usage

The following doesn't cover properly how to develop the main script scripts/generate-index-ts-file.js.

# To install all (dev)dependencies
npm ci

# To grab the latest version of the list of all missing enum fields from `@nestjs/swagger` and `@nestjs/common`
npm run download

# To generate the index.ts file
npm run create

# To compile the index.ts file everytime some change is made on it
npm run dev