🎉 Initial commit with error handling logic

Author: Jszigeti

.gitignore

@@ -0,0 +1,4 @@
+/node_modules
+/dist
+*.log
+package-lock.json

README.md

@@ -0,0 +1,137 @@
+# axios-error-handler
+
+A simple and flexible error handler for Axios requests, allowing customizable error messages based on HTTP status codes. It helps manage API error responses by providing clear and customized messages depending on the status code returned by the server.
+
+## Installation
+
+To install `axios-error-handler`, you can use npm or yarn:
+
+### Using npm:
+
+```bash
+npm install axios-error-handler
+```
+
+### Using yarn:
+
+```bash
+yarn add axios-error-handler
+```
+
+## Usage
+
+You can use `axios-error-handler` to handle errors in your Axios requests by customizing error messages based on HTTP status codes.
+
+### Basic Usage (Single Status Code)
+
+```typescript
+import { handleError } from "axios-error-handler";
+
+// Example function
+handleError(error, 403, "Email or password incorrect.");
+// if AxiosError and status === 403: "Email or password incorrect."
+```
+
+### Advanced Usage (Multiple Status Codes)
+
+You can also provide custom error messages for multiple HTTP status codes:
+
+```typescript
+import { handleError } from "axios-error-handler";
+
+// Example function
+handleError(error, [403, 404], {
+  403: "You are not allowed to access this resource.",
+  404: "Group is not found.",
+});
+// if AxiosError and status === 403: "You are not allowed to access this resource."
+// if AxiosError and status === 404: "Group is not found."
+```
+
+### Server Error Handling
+
+If the error status doesn't match any of the provided codes and is related to a server error (status 500+), the handler will return a default server error message.
+
+```typescript
+import { handleError } from "axios-error-handler";
+
+// Example function
+handleError(error, 403, "Email or password incorrect.");
+// If AxiosError and status === 500: "A server error occurred. Please try again later."
+```
+
+### Default Error Handling
+
+If the error status doesn't match any of the provided codes, the handler will return a default error message.
+
+```typescript
+import { handleError } from "axios-error-handler";
+
+// Example function
+handleError(error, 403, "Email or password incorrect.");
+// If AxiosError and status !== 403 | status > 500: "An unknown error occurred."
+// If Error : error.message
+// If unknown error : 'An unknown error occurred.'
+```
+
+### Options
+
+#### `errorCodesToCheck` (required)
+
+- **Type**: `number | number[]`
+- **Description**: The status code(s) to check for in the Axios error response. You can pass a single status code or an array of status codes.
+
+#### `errorMessages` (required)
+
+- **Type**: `string | Record<number, string>`
+- **Description**: The custom error message(s) for the specified status code(s). If you pass a single string, it will be used for all errors.
+
+If passing a `Record<number, string>`, the object keys represent status codes and values represent corresponding error messages.
+
+## Example
+
+```typescript
+import { handleError } from "axios-error-handler";
+
+try {
+  // Axios request here
+} catch (error: unknown) {
+  const errorMessage = handleError(error, [403, 404], {
+    403: "You are not authorized to access this resource.",
+    404: "Requested resource not found.",
+  });
+
+  console.log(errorMessage);
+  // Output the error message :
+  // If AxiosError and status === 403: 'You are not authorized to access this resource.'
+  // If AxiosError and status === 404: 'Requested resource not found.'
+  // If Axios Error and status >= 500: 'A server error occurred. Please try again later.'
+  // If Axios Error and status < 500 | status !== 403 | status !== 404: 'An unknown error occurred.'
+  // If Error : error.message
+  // If unknown error : 'An unknown error occurred.'
+}
+```
+
+## Development
+
+To contribute to the project, clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/Jszigeti/axios-error-handler.git
+cd axios-error-handler
+npm install
+```
+
+### Building
+
+To compile the TypeScript code into JavaScript, run:
+
+```bash
+npm run build
+```
+
+This will generate the compiled code in the `dist` directory.
+
+## License
+
+This project is licensed under the MIT License.

package.json

@@ -0,0 +1,25 @@
+{
+  "name": "axios-error-handler",
+  "version": "1.0.0",
+  "description": "A simple helper to handle errors in Axios requests with customizable messages.",
+  "main": "src/errorHandler.ts",
+  "types": "src/errorHandler.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "axios",
+    "error",
+    "handler",
+    "helper",
+    "typescript"
+  ],
+  "author": "Jonas Szigeti",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.7.9"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.2"
+  }
+}

src/errorHandler.ts

@@ -0,0 +1,24 @@
+import { AxiosError } from "axios";
+
+export const handleError = (
+  error: unknown,
+  errorCodesToCheck: number | number[],
+  errorMessages: string | Record<number, string>
+): string => {
+  if (typeof errorMessages === "string") {
+    return errorMessages;
+  }
+  const codesToCheck = Array.isArray(errorCodesToCheck)
+    ? errorCodesToCheck
+    : [errorCodesToCheck];
+  if (error instanceof AxiosError && error.response) {
+    const status = error.response.status;
+    if (codesToCheck.includes(status) && errorMessages[status])
+      return errorMessages[status];
+    if (status >= 500)
+      return "A server error occurred. Please try again later.";
+    return "An unknown error occurred.";
+  }
+  if (error instanceof Error) return error.message;
+  return "An unknown error occurred.";
+};

tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "lib": ["es2016", "dom"],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules"]
+}