Threshold of `false` seems confusing

Is threshold option being false means never compress no matter response size, or default threshold of 1 KiB, or something else?

// will compress any size
app.use(compression({threshold: 0}))

// returns JSON as plain text
app.use(compression({threshold: false}))

Makes sense to me that above two lines should be equivalent, but doesn’t seem to be the case. Should either change this, or add more detailed description into README.

---

❤️ to everyone working on this 😊

[dougwilson]

Hi @elmigranto sorry you were having trouble using the module. At first when I read your issue I was confused because I didn’t even know that false was a value allowed for the threshold option at all. I looked at it was indeed listed in the docs as a value, though when I checked in the tests there is no tests for such a value.

The implementation clearly does not support the value, as you observed.

I took a look back at the history of this project, various points in time of the implementation show that false has never been a supported value and looking at how it got added in the readme, it looks like a mistake that it got there at all.

I’m going to fix the readme for the time being.

I never thought about false being a possible value, but I think that makes sense I suppose. If you are interested in seeing false be a supported value, you’re welcome to make a pull request to support it, of course 👍

[elmigranto]

0 does the trick for me, so I think simply dropping that bit from the docs is just fine. Thanks, Doug.