Skip to content

Refactoring & Named Imports #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 18, 2025
Merged

Refactoring & Named Imports #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aae46a1
ADD SOCKET.IO BADGE
Skillnter Feb 5, 2025
27aad43
Merge branch 'master' of https://github.com/Skillnter/http-response-s…
Skillnter Feb 15, 2025
d58b0fc
CODE REFACTOR & INTRODUCTION OF NAMED IMPORTS
Skillnter Feb 18, 2025
431976b
Merge branch 'dev' of https://github.com/Skillnter/http-response-stat…
Skillnter Feb 18, 2025
c00300d
ADD JSDOC FOR STATUS NAME EXPORTS
Skillnter Feb 18, 2025
f2add9d
ADD JSDOC FOR ENUM CODES
Skillnter Feb 18, 2025
08e8717
UPDATE VERSION
Skillnter Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 32 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ All HTTP Status Codes from [Wikipedia - List of HTTP status codes](https://en.wi
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7d55170d359c475e9e586fd00e00841e)](https://app.codacy.com/gh/Skillnter/http-response-status-code/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
![npms.io (final)](https://img.shields.io/npms-io/maintenance-score/http-response-status-code?color=brightgreen)
![npm](https://img.shields.io/npm/dy/http-response-status-code)
[![Socket Badge](https://socket.dev/api/badge/npm/package/http-response-status-code/1.7.4)](https://socket.dev/npm/package/http-response-status-code/overview/1.7.4)
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-121013?logo=github&logoColor=white)](https://skillnter.github.io/http-response-status-code/)
[![Github Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-30363D?&logo=GitHub-Sponsors&logoColor=EA4AAA)](https://github.com/sponsors/Skillnter)
[![Open Collective](https://img.shields.io/badge/Open%20Collective-3385FF?logo=open-collective&logoColor=white)](https://opencollective.com/http-response-status-code)
Expand Down Expand Up @@ -53,10 +54,18 @@ npm install http-response-status-code
var STATUS_CODES = require('http-response-status-code');
// OR
import * as STATUS_CODES from 'http-response-status-code';
// OR
import { OK, getStatusName, CODES } from 'http-response-status-code';

console.log(STATUS_CODES.getStatusName(STATUS_CODES.OK));
// OK

console.log(getStatusName(OK));
// OK

console.log(OK);
// 200

console.log(STATUS_CODES.getStatusDescription(STATUS_CODES.INTERNAL_SERVER_ERROR));
// Internal Server Error

Expand Down Expand Up @@ -92,7 +101,7 @@ Returns the HTTP status code from status code name.

#### Returns

- `code` (`number`): The code number of the status if successful.
- `code` (`number`): The code number of the status if code exists.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][getStatusCode])
Expand All @@ -104,15 +113,15 @@ console.log(STATUS_CODES.getStatusCode("IM_A_TEAPOT")); // 418

### 2. Get Status Name

Returns the HTTP status code name from status code.
Returns the HTTP status code name from status code (e.g., `418`).

#### Parameters

- `code` (`number`): The code number of the status (e.g., `418`).

#### Returns

- `name` (`String`): The name of the status code if successful.
- `name` (`String`): The name of the status code if name exists.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][getStatusName])
Expand All @@ -128,11 +137,11 @@ Returns the status description from HTTP status code (e.g., `418`).

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `418`).

#### Returns

- `name` (`String`): The description of the status code if successful.
- `name` (`String`): The description of the status code if code exists.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][getStatusDescription])
Expand All @@ -148,11 +157,11 @@ Determines whether the specified status code represents an informational status.

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `100`).

#### Returns

- `result` (`boolean`): Returns `true` if the status code represents a informational status code (1xx), otherwise returns `false`.
- `isInformational` (`boolean`): Returns `true` if the status code represents a informational status code (1xx), otherwise returns `false`.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][isInformational])
Expand All @@ -165,7 +174,7 @@ console.log(STATUS_CODES.isInformational(200)); // False

### 5. List Informational Codes

Returns all the informational HTTP status codes.
Provides a list of all the informational HTTP status codes.

#### Returns

Expand All @@ -184,11 +193,11 @@ Determines whether the specified status code represents a success status.

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `200`).

#### Returns

- `result` (`boolean`): Returns `true` if the status code represents a successful response (2xx), otherwise returns `false`.
- `isSuccess` (`boolean`): Returns `true` if the status code represents a success status code (2xx), otherwise returns `false`.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][isSuccess])
Expand All @@ -201,7 +210,7 @@ console.log(STATUS_CODES.isSuccess(100)); // False

### 7. List Success Codes

Returns all the success HTTP status codes.
Provides a list of all the success HTTP status codes.

#### Returns

Expand All @@ -220,11 +229,11 @@ Determines whether the specified status code represents a redirection status.

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `300`).

#### Returns

- `result` (`boolean`): Returns `true` if the status code represents a redirection status code (3xx), otherwise returns `false`.
- `isRedirectional` (`boolean`): Returns `true` if the status code represents a redirection status code (3xx), otherwise returns `false`.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][isRedirectional])
Expand All @@ -237,7 +246,7 @@ console.log(STATUS_CODES.isRedirectional(100)); // False

### 9. List Redirection Codes

Returns all the redirection HTTP status codes.
Provides a list of all the redirection HTTP status codes.

#### Returns

Expand All @@ -256,11 +265,11 @@ Determines whether the specified status code represents a client side error stat

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `400`).

#### Returns

- `result` (`boolean`): Returns `true` if the status code represents a client side error code (4xx), otherwise returns `false`.
- `isClientError` (`boolean`): Returns `true` if the status code represents a client side error code (4xx), otherwise returns `false`.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][isClientError])
Expand All @@ -273,7 +282,7 @@ console.log(STATUS_CODES.isClientError(100)); // False

### 11. List Client Side Error Codes

Returns all the client side error HTTP status codes.
Provides a list of all the client side error HTTP status codes.

#### Returns

Expand All @@ -292,11 +301,11 @@ Determines whether the specified status code represents a server side error stat

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `500`).

#### Returns

- `result` (`boolean`): Returns `true` if the status code represents a server side error code (5xx), otherwise returns `false`.
- `isServerError` (`boolean`): Returns `true` if the status code represents a server side error code (5xx), otherwise returns `false`.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][isServerError])
Expand All @@ -309,7 +318,7 @@ console.log(STATUS_CODES.isServerError(100)); // False

### 13. List Server Side Error Codes

Returns all the server side error HTTP status codes.
Provides a list of all the server side error HTTP status codes.

#### Returns

Expand All @@ -328,11 +337,11 @@ Validates whether the provided status code is recognized as valid.

#### Parameters

- `code` (`number`): The code number of the status.
- `code` (`number`): The code number of the status (e.g., `500`).

#### Returns

- `result` (`boolean`): Returns `true` if the status code represents a valid status code (1xx, 2xx, ..., 5xx), otherwise returns `false`.
- `isValidStatusCode` (`boolean`): Returns `true` if the status code represents a valid status code (1xx, 2xx, ..., 5xx), otherwise returns `false`.
- `Error`: An error object if something goes wrong, containing details about the issue.

### Example ([Stackblitz][isValidStatusCode])
Expand Down Expand Up @@ -368,6 +377,7 @@ console.log(STATUS_CODES.isValidStatusCode(999)); // False
| 303 | HTTP_CODE_303 | SEE_OTHER | See Other
| 304 | HTTP_CODE_304 | NOT_MODIFIED | Not Modified
| 305 | HTTP_CODE_305 | USE_PROXY | Use Proxy
| 306 | HTTP_CODE_306 | SWITCH_PROXY | Switch Proxy
| 307 | HTTP_CODE_307 | TEMPORARY_REDIRECT | Temporary Redirect
| 308 | HTTP_CODE_308 | PERMANENT_REDIRECT | Permanent Redirect
| 400 | HTTP_CODE_400 | BAD_REQUEST | Bad Request
Expand Down
2 changes: 0 additions & 2 deletions index.d.ts
View file
Open in desktop

This file was deleted.

Loading