Option to always include headers, address range-not-satisfiable

devinivy commented 4 years ago

Two small features are implemented here:

meta.alwaysIncludeHeaders allows headers to always be included (when location is 'header') even when the result set is out-of-range or fits on a single page. The content-range header takes the form */totalCount when out-of-range. Technically this resolves #68.
As a result, in order to speak to RFC 7233 there should also be a way to indicate that the range is not satisfiable using a status code (typically 416), so a new option meta. rangeNotSatisfiableStatusCode has been introduced to address that.

Both of these changes should be fully backwards-compatible.

coveralls commented 4 years ago

Coverage remained the same at 100.0% when pulling ce6d29b7dd15ee27752a52d229c2533c680b8081 on devinivy:opt-always-include-headers into 6addeddd63e0f72cd32b5ce4d72eb0c7bd476094 on fknop:master.

fknop commented 4 years ago

LGTM, I'm gonna make a release ASAP

devinivy commented 4 years ago

Well, that was quick! Thank you! 🙂

fknop / hapi-pagination

Option to always include headers, address range-not-satisfiable #87