http-status-codes
Advanced tools
http-status-codes - npm Package Compare versions
Comparing version 2.0.0-beta.7 to 2.0.0-beta.8
| { | ||
| "name": "http-status-codes", | ||
| "version": "2.0.0-beta.7", | ||
| "version": "2.0.0-beta.8", | ||
| "description": "Constants enumerating the HTTP status codes. Based on the Java Apache HttpStatus API.", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -15,6 +15,11 @@ # http-status-codes | ||
| ## ES6 Modules Usage (express 4.x) | ||
| ## Usage (express 4.x) | ||
| ```typescript | ||
| import { StatusCodes, ReasonPhrases, getReasonPhrase, getStatusCode } from 'http-status-codes'; | ||
| import { | ||
| ReasonPhrases, | ||
| StatusCodes, | ||
| getReasonPhrase, | ||
| getStatusCode, | ||
| } from 'http-status-codes'; | ||
@@ -38,26 +43,4 @@ response | ||
| ## CommonJS (Node) Usage (express 4.x) | ||
| ## Codes | ||
| ```javascript | ||
| import HttpStatusCodes from 'http-status-codes'; | ||
| response | ||
| .status(HttpStatusCodes.StatusCodes.OK) | ||
| .send(HttpStatusCodes.ReasonPhrases.OK); | ||
| response | ||
| .status(HttpStatusCodes.StatusCodes.INTERNAL_SERVER_ERROR) | ||
| .send({ | ||
| error: HttpStatusCodes.getReasonPhrase(HttpStatusCodes.StatusCodes.INTERNAL_SERVER_ERROR) | ||
| }); | ||
| response | ||
| .status(HttpStatusCodes.getStatusCode('Internal Server Error')) | ||
| .send({ | ||
| error: 'Internal Server Error' | ||
| }); | ||
| ``` | ||
| ## Codes | ||
| | Code | Constant | Reason Phrase | | ||
@@ -111,3 +94,3 @@ | ---- | ------------------------------- | ------------------------------- | | ||
| | 431 | REQUEST_HEADER_FIELDS_TOO_LARGE | Request Header Fields Too Large | | ||
| | 500 | INTERNAL_SERVER_ERROR | Server Error | | ||
| | 500 | INTERNAL_SERVER_ERROR | Internal Server Error | | ||
| | 501 | NOT_IMPLEMENTED | Not Implemented | | ||
@@ -123,15 +106,15 @@ | 502 | BAD_GATEWAY | Bad Gateway | | ||
| http-status-codes v2 is mostly backwards compatible with v1, there is a single breaking change and two recommended changes. | ||
| http-status-codes v2 is mostly backwards compatible with v1. There is a single breaking change and two recommended changes. | ||
| ### Breaking Change 'Server Error' | ||
| #### [Breaking Change] 'Server Error' | ||
| The reason phrase for the status code 500 has been changed from 'Server Error' to 'Internal Server Error'. This is the correct phrase according to RFC7231. If you have code that relies on the result of `getStatusText(500)` or `getReasonPhrase('Server Error')`, then this could affect you. | ||
| The reason phrase for the status code `500` has been changed from `"Server Error"` to `"Internal Server Error"`. This is the correct phrase according to RFC7231. If you are migrating from v1, and have code that relies on the result of `getStatusText(500)` or `getReasonPhrase('Server Error')`, then this could affect you. | ||
| ### Non-breaking change getStatusText renamed getReasonPhrase | ||
| #### [Non-breaking change] getStatusText renamed getReasonPhrase | ||
| The function getStatusText has been renamed to getReasonPhrase. The old function is still available but may be deprecated in a future version. To fix this, simply rename `getStatusText()` to `getReasonPhrase()`. The function is otherwise the same as it was before. | ||
| The function `getStatusText` has been renamed to `getReasonPhrase`. The old function is still available, but may be deprecated in a future version. To fix this simply rename instances of `getStatusText()` to `getReasonPhrase()`. The function is otherwise the same as it was before. | ||
| ### Non-breaking change StatusCodes | ||
| #### [Non-breaking change] StatusCodes | ||
| In http-status-codes v1, Status Codes were exported directly from the top-level module. i.e. `HttpStatus.OK`. In v2 all Status Codes live under an object called `HttpStatus.StatusCodes`. We made this change to cater to TypeScript users who prefer a dedicated value with an enum type. The previous values are still exported, but we won't continue to update them. Please migrate if you're using the old-style imports. | ||
| In http-status-codes v1, Status Codes were exported directly from the top-level module. i.e. `HttpStatus.OK`. In v2 all Status Codes live under an object called `StatusCodes`. i.e. `HttpStatus.StatusCodes.OK`. We made this change to cater to TypeScript users who prefer a dedicated value with an enum type. The previous values are still exported, but we won't continue to update them. Please migrate if you're using the old-style imports. | ||
@@ -141,7 +124,7 @@ ## Proposing a new status code | ||
| If you'd like to propose a new status code, feel free to update "codes.json" with the necessary | ||
| information and open a pull request. No need to modify source code or even this README. | ||
| The update-codes script will handle this all for you. | ||
| information and open a pull request. There is no need to modify source code or even this README. | ||
| This is done automatically by `npm run update-codes`. | ||
| In general, we try to include only codes that have an official RFC and have been approved, however | ||
| exceptions will be made if the code is already in widespread use in the wild. | ||
| exceptions can be made if the code is already in widespread use in the wild. | ||
@@ -148,0 +131,0 @@ ## Steps to build and publish |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.37%
112504
- Number of lines in readme file
- decreased by-11.18%
135
No dependency changes