lukeed / lukeed/polka

Build a list of native or Polka-compatible middleware

Open
#85 8 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
5.6k
Forks
176
PR merge metrics
No merged PRs in 30d

Description

Pretty much what it says on the title. It would be awesome to know which middlewares are compatible with Polka or made exclusively with Polka in mind.

So far I haven't found any, but maybe some middleware can break while running on Polka because [it uses IncomingMessage and ServerResponse](https://github.com/lukeed/polka#handlers) while Express uses their own implementation of a [request module](https://github.com/expressjs/express/blob/master/lib/request.js) and a [response module](https://github.com/expressjs/express/blob/master/lib/response.js).

If deemed unnecessary, the issue can be closed. But for now, here are the lists:

### Native to Polka

- sirv

### Compatible, tested by the creator

- body-parser
- cors
- compression
- morgan
- sapper
- serve-static

### Compatible, tested by users

- express-fileupload
- helmet
- http-proxy-middleware
- response-time
- favicon

### Incompatible

- Nothing so far

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Polka's linked handlers documentation and compare its IncomingMessage/ServerResponse contract with Express's linked request and response modules. Verify the middleware listed in the issue, then document accurate native, compatible, and incompatible categories; done means the list is supported by compatibility checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.