1.0.0 • Published 3 years ago

request_trimmer v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

request_trimmer

While working with strings I often forget to trim some of the strings and It shoots me in my foot later on. I generally have to trim all strings that come with request body and query parameters. What if we have some utility which will do all trimming of strings sitting deep down in a object for us. Say hello to request_trimmer :smile:

request_trimmer provides you 4 express middlewares:

  • trim_all
  • trim_body
  • trim_query
  • trim_params

And one utility function:

  • trim_util : This utility function can be used to trim any object. I generally use it when I receive data from some external apis.

Installation

Use the package manager npm to install the package

npm i request_trimmer

Usage

Javascript

const express =  require('express');
const app = express();

const { trim_all,trim_body,trim_params,trim_util } = require('request_trimmer');
app.use(express.json());
# trim request body and query.
app.use(trim_all)

Remember params are yet not available to the middleware so trim_all can't trim req.params.

# trim request body only
app.use(trim_body)
//trim request body,query and params
app.post("\posts\:id",trim_all,(req,res) => {...});

we are using trim_all after route match so req.params are now available. This will trim request body,query and params. But any middleware running before the route match still gets untrimmed request.

Example

Request body ( Before request_trimmer )

{
    "arg1": {
        "arg2": [
            {
                "arg3": " val3 ",
                "arg4": "   val4 ",
                "arg5": [
                    "val5 ",
                    "  val5.1   "
                ]
            }
        ]
    },
    "arg6": "    val6   "
}

Request body( After request_trimmer )

{
    "arg1": {
        "arg2": [
            {
                "arg3": "val3",
                "arg4": "val4",
                "arg5": [
                    "val5",
                    "val5.1"
                ]
            }
        ]
    },
    "arg6": "val6"
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT