@albertdz/consumer
2.3.0 • Public • Published
- Crear archivo
consumer-setup.js
en la raiz del proyecto
- Agregar el siguiente código
const setup = {
baseUrl: 'https://restcountries.com',
headers: {
'Content-Type': 'application/json',
},
methods: {
countries: {
url: '/v3.1/all',
method: 'GET',
},
getCountry: {
url: '/v3.1/name/{name}',
method: 'GET',
args: ['name']
},
}
};
module.exports = setup;
- Modificar
baseUrl
por la URL de la API a consumir
- Agregar las cabeceras necesarias en
headers
- En
methods
agregar los métodos a consultar, puede usar GET POST PUT PATCH DELETE
- Ahora puede agregar una
baseUrl
a cada método
import { request, getStatus, isSyncing, subscribe, unsubscribe } from '@albertdz/consumer'
const { request, getStatus, isSyncing, subscribe, unsubscribe } = require('@albertdz/consumer')
-
request
Función que realiza la consulta
-
getStatus
Función para obtener el estado de la consulta, inicia en offline
, los demas valores son pending error success
-
isSyncing
Función para saber si la consulta esta en progreso, es de tipo boolean
-
subscribe
Se subscribe a un evento status syncing
-
unsubscribe
Se da de baja a un evento status syncing
const { request } = require('@albertdz/consumer')
const data = { name: 'Myanmar' };
const queryParams = { fullText: true };
const response = await request('getCountry', { data, queryParams });
-
Data
: Valores configurados en args
-
queryParams
: Valores para consultas avanzandas. Ejemplo: /name?fullText=true
-
headers
: Cabeceras personalizadas para las consultas. Ejemplo 'Authorization': 'Bearer {token}'
-
bearer
: Valor para la cabecera Authorization
en caso de no pasarlo en headers
-
baseUrl
: Realiza una petición a una baseUrl diferente a la configurada en el consumer-setup.js
Package Sidebar
Install
Weekly Downloads
Last publish