Skip to content

Commit d1ccae1

Browse files
authored
Merge pull request #11 from neylorxt/dev
new package name - Update package name - Package renamed to @neylorxt/react-request
2 parents b8aaa84 + 06c5c8d commit d1ccae1

4 files changed

Lines changed: 51 additions & 37 deletions

File tree

README.fr.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
# @neylorxt/react-api
1+
# @neylorxt/react-request
2+
3+
> **Note :** Ce package était anciennement connu sous le nom de `@neylorxt/react-api`. Le nom a été mis à jour en `@neylorxt/react-request` pour plus de clarté.
24
35
[English Version](README.md)
46

5-
**@neylorxt/react-api** est un mini-package léger qui simplifie l'envoi de données avec [Axios](https://axios-http.com/) dans vos projets. Conçu pour être simple et accessible aux débutants.
7+
**@neylorxt/react-request** est un mini-package léger qui simplifie l'envoi de données avec [Axios](https://axios-http.com/) dans vos projets. Conçu pour être simple et accessible aux débutants.
68

7-
## 🤔 Pourquoi utiliser React API ?
9+
## 🤔 Pourquoi utiliser React Request ?
810

9-
Quand on débute, interagir avec des serveurs (API) peut sembler compliqué. **React API** a été créé pour vous faciliter la vie :
11+
Quand on débute, interagir avec des serveurs (API) peut sembler compliqué. **React Request** a été créé pour vous faciliter la vie :
1012

1113
- **Simple à utiliser** : Des fonctions claires pour chaque besoin (recevoir, envoyer, mettre à jour).
1214
- **Gestion des erreurs simplifiée** : Fini les `try...catch` à rallonge. On vous retourne un objet simple pour savoir si tout s'est bien passé.
1315
- **Standardisé** : Les réponses du serveur sont toujours au même format, facile à traiter.
1416

15-
En gros, vous vous concentrez sur votre application, et **React API** s'occupe de la communication avec le serveur.
17+
En gros, vous vous concentrez sur votre application, et **React Request** s'occupe de la communication avec le serveur.
1618

1719

1820
## 🚀 Installation
@@ -21,11 +23,11 @@ Pour utiliser ce package, vous devez avoir `axios` installé dans votre projet.
2123

2224
```bash
2325
npm install axios
24-
npm install @neylorxt/react-api
26+
npm install @neylorxt/react-request
2527

2628
ou
2729

28-
npm install axios @neylorxt/react-api
30+
npm install axios @neylorxt/react-request
2931
```
3032

3133
## ✨ Comment ça marche ?
@@ -40,7 +42,7 @@ Pour recevoir (GET) des données.
4042
**Exemple :**
4143

4244
```javascript
43-
import { getData } from '@neylorxt/react-api';
45+
import { getData } from '@neylorxt/react-request';
4446

4547
const response = await getData('https://api.example.com/posts/1');
4648
if (response.success) {
@@ -61,7 +63,7 @@ Pour envoyer (POST) de nouvelles données.
6163
**Exemple :**
6264

6365
```javascript
64-
import { sendData } from '@neylorxt/react-api';
66+
import { sendData } from '@neylorxt/react-request';
6567

6668
const newPost = { title: 'Mon super article', content: '...' };
6769
const response = await sendData('https://api.example.com/posts', newPost);
@@ -82,7 +84,7 @@ Pour mettre à jour (PUT) des données existantes.
8284
**Exemple :**
8385

8486
```javascript
85-
import { updateData } from '@neylorxt/react-api';
87+
import { updateData } from '@neylorxt/react-request';
8688

8789
const updatedPost = { title: 'Mon titre mis à jour' };
8890
const response = await updateData('https://api.example.com/posts/1', updatedPost);
@@ -102,7 +104,7 @@ Pour supprimer (DELETE) des données.
102104
**Exemple :**
103105

104106
```javascript
105-
import { deleteData } from '@neylorxt/react-api';
107+
import { deleteData } from '@neylorxt/react-request';
106108

107109
const response = await deleteData('https://api.example.com/posts/1');
108110

@@ -124,7 +126,7 @@ C'est la fonction "couteau suisse". Elle peut tout faire !
124126
**Exemple :**
125127

126128
```javascript
127-
import { sendRequest } from '@neylorxt/react-api';
129+
import { sendRequest } from '@neylorxt/react-request';
128130

129131
// Requête GET simple
130132
const { data } = await sendRequest('https://api.example.com/users');
@@ -135,7 +137,11 @@ const config = {
135137
};
136138
const response = await sendRequest('https://api.example.com/posts/1', {
137139
method: 'delete',
138-
config: config
140+
config: config,
141+
params: {
142+
id: 1,
143+
...
144+
}
139145
});
140146

141147
if (response.success) {
@@ -162,7 +168,7 @@ Voici les propriétés les plus courantes que vous pouvez utiliser :
162168
**Exemple avec `config`:**
163169

164170
```javascript
165-
import { getData } from '@neylorxt/react-api';
171+
import { getData } from '@neylorxt/react-request';
166172

167173
const token = 'votre-token-secret';
168174

@@ -211,7 +217,7 @@ Vous pouvez toujours vérifier la propriété `success` pour déterminer si votr
211217

212218
## 🤝 Contribuer
213219

214-
Ce projet est open-source. Si vous voulez l'améliorer, n'hésitez pas à ouvrir une *issue* ou une *pull request* sur [GitHub](https://github.com/neylorxt/react-api).
220+
Ce projet est open-source. Si vous voulez l'améliorer, n'hésitez pas à ouvrir une *issue* ou une *pull request* sur [GitHub](https://github.com/neylorxt/react-request).
215221

216222
## 📜 Licence
217223

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# @neylorxt/react-api
1+
# @neylorxt/react-request
2+
3+
> **Note:** This package was formerly known as `@neylorxt/react-api`. The name has been updated to `@neylorxt/react-request` for clarity.
24
35
[Version Française](README.fr.md)
46

5-
**@neylorxt/react-api** is a lightweight wrapper around [Axios](https://axios-http.com/) that simplifies HTTP requests in your projects. It's designed to be straightforward and beginner-friendly.
7+
**@neylorxt/react-request** is a lightweight wrapper around [Axios](https://axios-http.com/) that simplifies HTTP requests in your projects. It's designed to be straightforward and beginner-friendly.
68

79
## 🤔 Why Use It?
810

@@ -18,11 +20,11 @@ First, ensure you have `axios` in your project, as it is a required peer depende
1820

1921
```bash
2022
npm install axios
21-
npm install @neylorxt/react-api
23+
npm install @neylorxt/react-request
2224

2325
or
2426

25-
npm install axios @neylorxt/react-api
27+
npm install axios @neylorxt/react-request
2628
```
2729

2830
## ✨ API Reference
@@ -37,7 +39,7 @@ Use this function to fetch data from an endpoint (HTTP GET).
3739
**Example:**
3840

3941
```javascript
40-
import { getData } from '@neylorxt/react-api';
42+
import { getData } from '@neylorxt/react-request';
4143

4244
const response = await getData('https://api.example.com/posts/1');
4345

@@ -59,7 +61,7 @@ Use this function to create new data (HTTP POST).
5961
**Example:**
6062

6163
```javascript
62-
import { sendData } from '@neylorxt/react-api';
64+
import { sendData } from '@neylorxt/react-request';
6365

6466
const newPost = { title: 'My Awesome Post', content: '...' };
6567
const response = await sendData('https://api.example.com/posts', newPost);
@@ -80,7 +82,7 @@ Use this function to update existing data (HTTP PUT).
8082
**Example:**
8183

8284
```javascript
83-
import { updateData } from '@neylorxt/react-api';
85+
import { updateData } from '@neylorxt/react-request';
8486

8587
const updatedData = { title: 'My Updated Title' };
8688
const response = await updateData('https://api.example.com/posts/1', updatedData);
@@ -100,7 +102,7 @@ Use this function to delete data (HTTP DELETE).
100102
**Example:**
101103

102104
```javascript
103-
import { deleteData } from '@neylorxt/react-api';
105+
import { deleteData } from '@neylorxt/react-request';
104106

105107
const response = await deleteData('https://api.example.com/posts/1');
106108

@@ -122,7 +124,7 @@ This is a general-purpose function that can handle any type of HTTP request.
122124
**Example:**
123125

124126
```javascript
125-
import { sendRequest } from '@neylorxt/react-api';
127+
import { sendRequest } from '@neylorxt/react-request';
126128

127129
// A simple GET request
128130
const { data } = await sendRequest('https://api.example.com/users');
@@ -133,7 +135,11 @@ const config = {
133135
};
134136
const response = await sendRequest('https://api.example.com/posts/1', {
135137
method: 'delete',
136-
config: config
138+
config: config,
139+
params: {
140+
id: 1,
141+
...
142+
}
137143
});
138144

139145
if (response.success) {
@@ -160,7 +166,7 @@ Here are some of the most common properties you can use:
160166
**Example using `config`:**
161167

162168
```javascript
163-
import { getData } from '@neylorxt/react-api';
169+
import { getData } from '@neylorxt/react-request';
164170

165171
const token = 'your-secret-auth-token';
166172

@@ -209,7 +215,7 @@ You can always check the `success` property to determine if your request was suc
209215

210216
## 🤝 Contributing
211217

212-
This is an open-source project. If you want to help improve it, feel free to open an issue or a pull request on [GitHub](https://github.com/neylorxt/react-api).
218+
This is an open-source project. If you want to help improve it, feel free to open an issue or a pull request on [GitHub](https://github.com/neylorxt/react-request).
213219

214220
## 📜 License
215221

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
{
2-
"name": "@neylorxt/react-api",
3-
"version": "0.0.2",
2+
"name": "@neylorxt/react-request",
3+
"version": "0.0.3",
44
"description": "It's a mini package that makes it easy for you to send data via axios.",
55
"keywords": [
66
"neylorxt",
7-
"react-api",
8-
"neylorxt-react-api",
7+
"react-request",
8+
"neylorxt-react-request",
9+
"request",
10+
"react-js",
911
"api"
1012
],
11-
"homepage": "https://github.com/neylorxt/react-api#readme",
13+
"homepage": "https://github.com/neylorxt/react-request#readme",
1214
"bugs": {
13-
"url": "https://github.com/neylorxt/react-api/issues"
15+
"url": "https://github.com/neylorxt/react-request/issues"
1416
},
1517
"repository": {
1618
"type": "git",
17-
"url": "git+https://github.com/neylorxt/react-api.git"
19+
"url": "git+https://github.com/neylorxt/react-request.git"
1820
},
1921
"license": "MIT",
2022
"author": "neylorxt",

0 commit comments

Comments
 (0)