aziosxjs 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,178 @@
+# Aziosxjs
+
+A lightweight HTTP client for Node.js inspired by Axios.
+
+Aziosxjs provides a simple and clean API for making HTTP requests while keeping the internal architecture modular and extensible.
+
+This project was built to explore how HTTP client libraries like Axios work internally, including request pipelines, interceptors, and adapter-based networking.
+
+---
+
+## Features
+
+* Simple and clean API
+* Promise-based HTTP requests
+* Built using low-level Node.js `http` and `https` modules
+* Interceptor system for request/response manipulation
+* TypeScript support
+* Modular architecture for future extensions
+
+---
+
+## Installation
+
+Install the package using npm:
+
+```
+npm install aziosxjs
+```
+
+---
+
+## Quick Example
+
+```javascript
+import azios from "aziosxjs";
+
+async function getUsers() {
+  const response = await azios.get(
+    "https://jsonplaceholder.typicode.com/users"
+  );
+
+  console.log(response.data);
+}
+
+getUsers();
+```
+
+---
+
+## Basic Usage
+
+### GET Request
+
+```javascript
+const res = await azios.get("https://api.example.com/users");
+
+console.log(res.data);
+```
+
+---
+
+### POST Request
+
+```javascript
+const res = await azios.post(
+  "https://api.example.com/login",
+  {
+    username: "user",
+    password: "password"
+  }
+);
+
+console.log(res.data);
+```
+
+---
+
+## Interceptors
+
+Interceptors allow you to modify requests or responses globally.
+
+### Request Interceptor
+
+```javascript
+azios.interceptors.request.use(config => {
+  console.log("Request intercepted");
+  return config;
+});
+```
+
+---
+
+### Response Interceptor
+
+```javascript
+azios.interceptors.response.use(response => {
+  console.log("Response intercepted");
+  return response;
+});
+```
+
+---
+
+## Architecture Overview
+
+Aziosxjs follows a modular architecture:
+
+```
+User Code
+   ↓
+Azios Instance
+   ↓
+Request Interceptors
+   ↓
+dispatchRequest (HTTP engine)
+   ↓
+Node.js http/https modules
+   ↓
+Response Interceptors
+   ↓
+Return Response
+```
+
+---
+
+## Project Structure
+
+```
+src
+ ├── core
+ │    ├── Azios.ts
+ │    ├── createInstance.ts
+ │    └── dispatchRequest.ts
+ │
+ ├── interceptors
+ │    └── InterceptorManager.ts
+ │
+ ├── errors
+ │    └── AziosError.ts
+ │
+ ├── types
+ │    ├── config.ts
+ │    ├── request.ts
+ │    └── response.ts
+ │
+ └── index.ts
+```
+
+---
+
+## Roadmap
+
+Future improvements planned:
+
+* Interceptor execution pipeline
+* Automatic JSON parsing
+* Retry strategy
+* Request deduplication
+* Caching layer
+* Plugin system
+
+---
+
+## Contributing
+
+Contributions are welcome. Feel free to open issues or submit pull requests.
+
+---
+
+## Author
+
+Azeem Ali
+
+---
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aziosxjs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Lightweight HTTP client inspired by axios",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,21 @@
   "files": [
     "dist"
   ],
-  "keywords": ["http", "client", "axios", "request"],
+  "keywords": [
+    "http",
+    "client",
+    "axios",
+    "request",
+    "nodejs"
+  ],
   "author": "Azeem Ali",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/azeemali2001/azios"
+  },
+  "homepage": "https://github.com/azeemali2001/azios",
+  "bugs": {
+    "url": "https://github.com/azeemali2001/azios/issues"
+  }
+}