getStatusMessage updated

Author: dev-rashedin

README.md

@@ -50,8 +50,8 @@ console.log(StatusCodes.OK); // 200
 console.log(getStatusMessage(StatusCodes.NOT_FOUND));
 // Output: "Not Found"
 
-// Get a detailed message
-console.log(getStatusMessage(StatusCodes.NOT_FOUND, true));
+// Get a detailed message (pass 'detailed' as second parameter)
+console.log(getStatusMessage(StatusCodes.NOT_FOUND, 'detailed'));
 // Output: "Not Found: The requested resource could not be found but may be available in the future."
 
 // You can also access messages directly

__tests__/getStatusMessage.test.ts

@@ -20,27 +20,27 @@ describe('getStatusMessage', () => {
 
   // check if it returns a detailed message
   it('should return a detailed message if detailed = true', () => {
-    expect(getStatusMessage(StatusCodes.OK, true)).toMatch(/successful/i);
-    expect(getStatusMessage(StatusCodes.CREATED, true)).toMatch(
+    expect(getStatusMessage(StatusCodes.OK, 'detailed')).toMatch(/successful/i);
+    expect(getStatusMessage(StatusCodes.CREATED, 'detailed')).toMatch(
       /has been created/i
     );
-    expect(getStatusMessage(StatusCodes.NOT_FOUND, true)).toMatch(
+    expect(getStatusMessage(StatusCodes.NOT_FOUND, 'detailed')).toMatch(
       /cannot locate/i
     );
-    expect(getStatusMessage(StatusCodes.INSUFFICIENT_STORAGE, true)).toMatch(
+    expect(getStatusMessage(StatusCodes.INSUFFICIENT_STORAGE, 'detailed')).toMatch(
       /cannot store/i
     );
-    expect(getStatusMessage(StatusCodes.MOVED_PERMANENTLY, true)).toMatch(
+    expect(getStatusMessage(StatusCodes.MOVED_PERMANENTLY, 'detailed')).toMatch(
       /permanently moved /i
     );
-    expect(getStatusMessage(StatusCodes.PERMANENT_REDIRECT, true)).toMatch(
+    expect(getStatusMessage(StatusCodes.PERMANENT_REDIRECT, 'detailed')).toMatch(
       /permanent redirect/i
     );
   });
 
   // check if it returns a "Unknown Status" for invalid code
   it('should return a "Unknown Status" for invalid code', () => {
     expect(getStatusMessage(999 as any)).toBe('Unknown Status');
-    expect(getStatusMessage(600 as any, true)).toBe('Unknown Status');
+    expect(getStatusMessage(600 as any, 'detailed')).toBe('Unknown Status');
   });
 });

docs/status-codes-with-short-message.md

@@ -57,6 +57,7 @@ This document includes all the supported HTTP status codes provided by `http-sta
 | 422  | UNPROCESSABLE_ENTITY            | Unprocessable Entity            |
 | 423  | LOCKED                          | Locked                          |
 | 424  | FAILED_DEPENDENCY               | Failed Dependency               |
+| 425  | TOO_EARLY               | Too Early               |
 | 426  | UPGRADE_REQUIRED                | Upgrade Required                |
 | 428  | PRECONDITION_REQUIRED           | Precondition Required           |
 | 429  | TOO_MANY_REQUESTS               | Too Many Requests               |
@@ -81,28 +82,16 @@ This document includes all the supported HTTP status codes provided by `http-sta
 | Code | Constant                         | Message                                 |
 |------|-----------------------------------|------------------------------------------|
 | 419  | PAGE_EXPIRED                     | Page Expired                            |
-| 420  | METHOD_FAILURE                   | Method Failure                          |
 | 420  | ENHANCE_YOUR_CALM                | Enhance Your Calm                       |
 | 450  | BLOCKED_BY_WINDOWS_PARENTAL_CONTROLS | Blocked by Parental Controls       |
 | 498  | INVALID_TOKEN                    | Invalid Token                           |
-| 499  | TOKEN_REQUIRED                   | Token Required                          |
 | 509  | BANDWIDTH_LIMIT_EXCEEDED         | Bandwidth Limit Exceeded                |
 | 530  | SITE_IS_FROZEN                   | Site is Frozen                          |
 | 598  | NETWORK_READ_TIMEOUT_ERROR       | Network Read Timeout Error              |
 | 599  | NETWORK_CONNECT_TIMEOUT_ERROR    | Network Connect Timeout Error           |
 
 ---
 
-## 🪟 Microsoft IIS Codes
-
-| Code | Constant          | Message           |
-|------|-------------------|--------------------|
-| 440  | LOGIN_TIMEOUT     | Login Timeout      |
-| 449  | RETRY_WITH        | Retry With         |
-| 451  | REDIRECT          | Redirect           |
-
----
-
 ## 🧩 NGINX Specific Codes
 
 | Code | Constant                         | Message                                |

src/getStatusMessage.ts

@@ -5,9 +5,9 @@ import { DetailedStatusMessages } from './detailedStatusMessages';
 
 export function getStatusMessage(
   statusCode: StatusCode,
-  detailed = false
+  variant = 'default'
 ): string {
-  return detailed
+  return variant === 'detailed'
     ? DetailedStatusMessages[statusCode] ?? 'Unknown Status'
     : StatusMessages[statusCode] ?? 'Unknown Status';
 }