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

@universal-packages/express-parameters

v1.2.6

Published

universal-parameters as an express middleware.

Downloads

2,758

Readme

Express parameters

npm version Testing codecov

universal-parameters as an express middleware.

Install

npm install @universal-packages/express-parameters

npm install express

Middleware

parameters([unionKind])

Unites request relevant attributes to set a Parameters object in the request to pass to the following handlers.

import { parameters } from '@universal-packages/express-parameters'
import express from 'express'

const app = express()

app.use(parameters())

Union kind

By default the parameters middleware will use the request body as a subject for the Parameters object, you can pass another strategy depending your needs. For example:

app.use(parameters('params-body'))
  • join Joins all body, params and query as the subject.

  • separate Builds a new object using all body, params and query within their own keys as the subject.

  • body Uses body as the subject.

  • body-params Joins body and params as the subject.

  • body-query Joins body and query as the subject.

  • query Uses query as the subject.

  • query-params Joins query and params as the subject.

  • params Uses params as the subject.

express params

In order for the middleware to access the params request object, it needs to be used as route handler.

import { parameters } from '@universal-packages/express-parameters'
import express from 'express'

const app = express()

app.get('/user/:id', parameters('join'), (request) => {
  console.log(equest.parameters.subject.id)
})

// > 1

express body

In order for the middleware to access the body request object, it needs to be previously parsed as json.

import { parameters } from '@universal-packages/express-parameters'
import express, { json } from 'express'

const app = express()

app.use(json())
app.use(parameters())
// > 1

Global methods

injectParameters(request: Request)

To only inject the parameters object into the request and don't behave as middle ware use this method. In case you are doing some custom middleware.

import { injectParameters } from '@universal-packages/express-parameters'
import express from 'express'

const app = express()

app.use((request, response, next) => {
  injectParameters(request)
  next()
})

// > 1

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

License

MIT licensed.