Code Monkey home page Code Monkey logo

nest-optional-validation-pipes's Introduction

Nest Optional Validation Pipes

What is this?

This package provides the same validation & transformation pipes as @nestjs/common does, but with optionality.

This means, for example, a ParseBoolOptionalPipe will validate & transform string parameters of the form "true" and "false" into proper booleans true and false but return undefined, if null or undefined is passed as input.

When would I use this?

This is especially useful in the case of optional @Query parameters: Let's say you wanted to add some kind of optional filtering for a resource in your api, so you add a flag as a @Query parameter - using the default ParseBoolPipe will throw an error if the flag is not provided on every request.

This package addresses this exact shortcoming: using a ParseBoolOptionalPipe instead of a ParseBoolPipe will mean the validation will not fail on "no flag provided" - it will return undefined instead, building a bridge.

How do I use this?

Exactly the same way you would use the @nestjs/common Built-in Pipes. See the official nestjs docs for further info.

Credits

Approximately 90% of the code is taken directly from @nestjs/common, I only put my own spin on their already awesome built-in pipes.

So go check them out! (If you don't know them, how did you end up here?)

nest-optional-validation-pipes's People

Contributors

jonasfeld avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.