wikies-api.js v1.1.1
Wikipedia API
Este paquete de Node.js te permite realizar búsquedas en Wikipedia y obtener información de los resultados de forma sencilla y flexible.
Instalación
Puedes instalar este paquete utilizando npm:
npm i wikies-api.js
Uso
Paso 1: Importa la función scrapeWikipedia
a tu proyecto JS o TS.:
const { scrapeWikipedia } = require('wikies-api.js');
const query = 'Wikipedia'
const limit = 3; // Número de resultados que deseas obtener
async function main() {
try {
const result = await scrapeWikipedia(query, limit);
if (result) {
console.log('Resultados encontrados:');
console.log(result);
} else {
console.log('No se encontraron resultados para la búsqueda.');
}
} catch (error) {
console.error('Error en la solicitud:', error);
}
}
main();
Funciones de scrapeWikipedia
La función scrapeWikipedia
acepta dos parámetros:
query
: La consulta que quieres realizar en Wikipedia.limit
: El número de resultados que deseas obtener (debe ser solo numeros mayores a 0).
La función realiza una solicitud a la API de Wikipedia y devuelve información sobre los resultados de la búsqueda en un formato estructurado.
Variables Retornadas por la Función
La función scrapeWikipedia
retorna un objeto con información detallada sobre los resultados de la búsqueda en Wikipedia. A continuación, se describen las variables que puedes esperar del objeto:
id
: El identificador único del resultado de la búsqueda en Wikipedia.key
: La clave única del resultado de la búsqueda.title
: El título del artículo o página de Wikipedia que corresponde al resultado.excerpt
: Un fragmento de texto que proporciona una breve descripción o resumen del artículo.matched_title
: El título coincidente si se encuentra una coincidencia parcial en la búsqueda.description
: Una descripción general del resultado, que puede incluir información adicional sobre el contenido.thumbnail
: Una URL de la miniatura (imagen) asociada al artículo, si está disponible.
Contribuir
¡Tú también puedes contribuir a este proyecto! Si encuentras problemas o tienes ideas para mejoras, no dudes en abrir un problema o enviar una solicitud (pull request) en el repositorio de GitHub.
Licencia
Este paquete está bajo la Licencia MIT. Puedes ver los detalles en el archivo LICENSE.